From cc6e137994af30fbed3bb1c3aed1a7c6d729af04 Mon Sep 17 00:00:00 2001 From: empty Date: Tue, 16 Dec 2025 10:55:18 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=96=87=E6=A1=A3=E7=94=9F=E5=91=BD?= =?UTF-8?q?=E5=91=A8=E6=9C=9F=E7=AE=A1=E7=90=86=E8=A7=84=E8=8C=83=E5=8C=96?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit CLAUDE.md: - 新增「文档管理」章节，明确文档分类和更新策略 - 核心原则：不创建需要手工同步的文档 删除过时文档: - PROJECT_STRUCTURE.md（代码即结构） - docs_index.md（直接浏览目录） 归档历史设计文档: - PRD/TECHSPEC/IXSPEC 移入 docs/archive/ 统一应用名称: - 所有文档中 "Live Photo Maker" → "Live Photo Studio" 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 --- CLAUDE.md | 24 +++++++++ PROJECT_STRUCTURE.md | 52 ------------------- docs/APP_STORE_METADATA.md | 8 +-- docs/TEST_MATRIX.md | 2 +- docs/USER_GUIDE.md | 2 +- .../IXSPEC_LivePhoto_App_V0.2_2025-12-13.md | 0 .../PRD_LivePhoto_App_V0.2_2025-12-13.md | 0 .../TECHSPEC_LivePhoto_App_V0.2_2025-12-13.md | 0 docs_index.md | 27 ---------- 9 files changed, 30 insertions(+), 85 deletions(-) delete mode 100644 PROJECT_STRUCTURE.md rename docs/{ => archive}/IXSPEC_LivePhoto_App_V0.2_2025-12-13.md (100%) rename docs/{ => archive}/PRD_LivePhoto_App_V0.2_2025-12-13.md (100%) rename docs/{ => archive}/TECHSPEC_LivePhoto_App_V0.2_2025-12-13.md (100%) delete mode 100644 docs_index.md diff --git a/CLAUDE.md b/CLAUDE.md index f387f13..268836a 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -57,3 +57,27 @@ xcodebuild -scheme to-live-photo -configuration Release -destination 'generic/pl - 新增 View 必须适配深色模式和 iPad - 触控目标 ≥ 44pt - 错误处理使用 `LivePhotoError` 枚举，禁止裸 `throw` + +## 文档管理 + +### 核心原则 +> 不创建需要手工同步的文档。如果信息会随代码变化，要么让代码自描述，要么接受文档必然过时。 + +### 文档分类 +| 类型 | 文件 | 更新策略 | +|-----|------|---------| +| 宪法 | `CLAUDE.md` | 谨慎修改，每次变更需明确意图 | +| 任务 | `TASK.md` | 活跃更新，追踪里程碑进度 | +| 运维 | `docs/TEST_MATRIX.md`, `docs/USER_GUIDE.md` | 随功能���更同步更新 | +| 上架 | `docs/APP_STORE_METADATA.md` | 版本发布前更新 | +| 归档 | `docs/archive/` | 只读，不再更新 | + +### 禁止创建 +- 目录结构文档（如 PROJECT_STRUCTURE.md）— 代码即结构 +- 文档索引（如 docs_index.md）— 直接浏览 docs/ 目录 +- 任何需要"记得同步"的描述性文档 + +### 更新触发 +- 新增/修改功能 → 同步 `USER_GUIDE.md` 相关章节 +- 新增测试场景 → 同步 `TEST_MATRIX.md` +- 归档文档 → 不更新，保持历史原貌 diff --git a/PROJECT_STRUCTURE.md b/PROJECT_STRUCTURE.md deleted file mode 100644 index 3d46a95..0000000 --- a/PROJECT_STRUCTURE.md +++ /dev/null @@ -1,52 +0,0 @@ -# 项目结构 - -> 说明：本文件用于记录项目目录/文件结构的变更。新增/删除目录或文件后需同步更新。 - -## 根目录 - -- Package.swift -- docs/ -- Sources/ -- Tests/ -- to-live-photo/ -- docs_index.md -- PROJECT_STRUCTURE.md -- TASK.md -- .DS_Store - -## docs/ - -- PRD_LivePhoto_App_V0.2_2025-12-13.md -- TECHSPEC_LivePhoto_App_V0.2_2025-12-13.md -- IXSPEC_LivePhoto_App_V0.2_2025-12-13.md -- .DS_Store - -## Sources/ - -- LivePhotoCore/ - - LivePhotoCore.swift - -## Tests/ - -- LivePhotoCoreTests/ - - LivePhotoCoreTests.swift - -## to-live-photo/ - -- to-live-photo.xcodeproj/ -- to-live-photo/ - - Assets.xcassets/ - - AppState.swift - - ContentView.swift - - to_live_photoApp.swift - - Views/ - - HomeView.swift - - EditorView.swift - - ProcessingView.swift - - ResultView.swift - - WallpaperGuideView.swift -- to-live-photoTests/ - - to_live_photoTests.swift -- to-live-photoUITests/ - - to_live_photoUITests.swift - - to_live_photoUITestsLaunchTests.swift diff --git a/docs/APP_STORE_METADATA.md b/docs/APP_STORE_METADATA.md index 307d7b1..387070f 100644 --- a/docs/APP_STORE_METADATA.md +++ b/docs/APP_STORE_METADATA.md @@ -1,4 +1,4 @@ -# App Store 上架元数据 +# Live Photo Studio - App Store 上架元数据 > 准备上传到 App Store Connect 的所有文案和信息 @@ -8,7 +8,7 @@ | 项目 | 内容 | |------|------| -| **应用名称** | Live Photo Maker | +| **应用名称** | Live Photo Studio | | **副标题** | 视频一键转动态壁纸 | | **Bundle ID** | xyz.let5see.livephotomaker | | **版本号** | 1.0 | @@ -28,7 +28,7 @@ ### 完整描述 ``` -Live Photo Maker 是一款简单易用的动态壁纸制作工具，让你的锁屏动起来！ +Live Photo Studio 是一款简单易用的动态壁纸制作工具，让你的锁屏动起来！ 主要功能： @@ -79,7 +79,7 @@ Live Photo,动态壁纸,锁屏壁纸,视频转换,AI增强,照片,壁纸,动图, ### 1.0 版本 ``` -Live Photo Maker 正式发布！ +Live Photo Studio 正式发布！ • 视频一键转换为 Live Photo • 多种比例模板，适配各种设备 diff --git a/docs/TEST_MATRIX.md b/docs/TEST_MATRIX.md index 25b01ad..e5587ef 100644 --- a/docs/TEST_MATRIX.md +++ b/docs/TEST_MATRIX.md @@ -1,4 +1,4 @@ -# Live Photo Maker 测试文档 +# Live Photo Studio 测试文档 ## 测试矩阵 diff --git a/docs/USER_GUIDE.md b/docs/USER_GUIDE.md index 78b5be3..c626767 100644 --- a/docs/USER_GUIDE.md +++ b/docs/USER_GUIDE.md @@ -1,4 +1,4 @@ -# Live Photo Maker 用户手册 +# Live Photo Studio 用户手册 ## 快速开始 diff --git a/docs/IXSPEC_LivePhoto_App_V0.2_2025-12-13.md b/docs/archive/IXSPEC_LivePhoto_App_V0.2_2025-12-13.md similarity index 100% rename from docs/IXSPEC_LivePhoto_App_V0.2_2025-12-13.md rename to docs/archive/IXSPEC_LivePhoto_App_V0.2_2025-12-13.md diff --git a/docs/PRD_LivePhoto_App_V0.2_2025-12-13.md b/docs/archive/PRD_LivePhoto_App_V0.2_2025-12-13.md similarity index 100% rename from docs/PRD_LivePhoto_App_V0.2_2025-12-13.md rename to docs/archive/PRD_LivePhoto_App_V0.2_2025-12-13.md diff --git a/docs/TECHSPEC_LivePhoto_App_V0.2_2025-12-13.md b/docs/archive/TECHSPEC_LivePhoto_App_V0.2_2025-12-13.md similarity index 100% rename from docs/TECHSPEC_LivePhoto_App_V0.2_2025-12-13.md rename to docs/archive/TECHSPEC_LivePhoto_App_V0.2_2025-12-13.md diff --git a/docs_index.md b/docs_index.md deleted file mode 100644 index 98e86f5..0000000 --- a/docs_index.md +++ /dev/null @@ -1,27 +0,0 @@ -# 文档索引 - -## 需求 - -- docs/PRD_LivePhoto_App_V0.2_2025-12-13.md：PRD（V0.2），定义目标、MVP范围、流程、验收与风险。 - -## 设计 - -- docs/TECHSPEC_LivePhoto_App_V0.2_2025-12-13.md：技术规格（V0.2），架构/模型/合成规范/错误码/缓存等。 -- docs/IXSPEC_LivePhoto_App_V0.2_2025-12-13.md：交互规格（V0.2），页面交互/状态/埋点/iPad适配等。 - -## 测试 - -- （待补充） - -## 用户手册 - -- （待补充） - -## 知识库 - -- docs_index.md：文档索引（本文件） - - PROJECT_STRUCTURE.md：项目结构（目录/文件结构变更记录） - -## 任务进度 - -- TASK.md：任务清单（按阶段拆解）