update-app-design

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Sync Application Design Document

同步应用设计文档

User Request: $ARGUMENTS
用户需求: $ARGUMENTS

Context

背景信息

  • Project root: !
    pwd
  • Package.json: @package.json
  • Current design doc: @.claude/skills/1-app-design-document.mdc
  • Last modified: !
    stat -f "%Sm" .claude/skills/1-app-design-document.mdc 2>/dev/null || echo "No existing document"
  • 项目根目录: !
    pwd
  • Package.json: @package.json
  • 当前设计文档: @.claude/skills/1-app-design-document.mdc
  • 最后修改时间: !
    stat -f "%Sm" .claude/skills/1-app-design-document.mdc 2>/dev/null || echo "No existing document"

Goal

目标

Update the existing Application Design Document to reflect current codebase state, new features, changed priorities, and project evolution. Maintain consistency with the original document while incorporating new information.
更新现有应用设计文档,以反映当前代码库状态、新增功能、变更的优先级以及项目演进情况。在纳入新信息的同时,保持与原文档的一致性。

Process

流程

1. Document Analysis

1. 文档分析

  • Read and understand the existing 1-app-design-document.mdc
  • Establish baseline understanding of documented features
  • Note the document's structure and tone
  • Identify areas that may need updates
  • 阅读并理解现有的1-app-design-document.mdc文档
  • 建立对已记录功能的基础认知
  • 记录文档的结构和语气
  • 识别可能需要更新的区域

2. Codebase Change Detection

2. 代码库变更检测

Think deeply about what has changed in the codebase since the document was last updated.
Analyze for:
  • New Features: Components, modules, or capabilities added
  • Modified Flows: Changes to user journeys or business logic
  • Removed Features: Deprecated or deleted functionality
  • Architecture Evolution: New patterns, services, or integrations
  • Scale Changes: Growth in complexity or user base
  • Security Updates: New authentication/authorization patterns
Extended thinking helps identify subtle changes, understand how new features integrate with existing ones, and recognize patterns that indicate architectural evolution.
深入思考自文档上次更新以来代码库发生了哪些变化。
从以下维度进行分析:
  • 新增功能: 添加的组件、模块或能力
  • 修改的流程: 用户旅程或业务逻辑的变更
  • 移除的功能: 已弃用或删除的功能
  • 架构演进: 新的模式、服务或集成
  • 规模变化: 复杂度或用户群体的增长
  • 安全更新: 新的认证/授权模式
深入思考有助于识别细微变更、理解新功能与现有功能的集成方式,并识别表明架构演进的模式。

3. Interactive Update Session

3. 交互式更新会话

CRITICAL: Ask project stage question FIRST to assess if priorities have changed:
  • Use lettered/numbered options for easy response
  • Focus on what has changed and why
  • Gather context for accurate updates
关键提示: 首先询问项目阶段问题,以评估优先级是否发生变化:
  • 使用字母/数字选项以便于回复
  • 聚焦于发生了哪些变化以及原因
  • 收集准确更新所需的背景信息

4. Update Project Configuration

4. 更新项目配置

If project stage or priorities have changed:
  • Update
    .claude/skills/3-project-status.mdc
  • Adjust DO/DON'T lists for new priorities
  • Document any stage transitions
如果项目阶段或优先级发生变化:
  • 更新
    .claude/skills/3-project-status.mdc
  • 根据新优先级调整DO/DON'T列表
  • 记录任何阶段转换情况

5. Sync Document

5. 同步文档

Update the document incrementally:
  • Preserve accurate existing content
  • Add new sections only when necessary
  • Update outdated information
  • Maintain consistent tone and structure
逐步更新文档:
  • 保留准确的现有内容
  • 仅在必要时添加新章节
  • 更新过时信息
  • 保持一致的语气和结构

6. Save Updated Document

6. 保存更新后的文档

  • Backup suggestion if major changes
  • Overwrite existing 1-app-design-document.mdc
  • Note what was updated
  • 若有重大变更,建议创建备份
  • 覆盖现有1-app-design-document.mdc文档
  • 记录更新内容

Required Questions Template

必问问题模板

🎯 CRITICAL: Project Evolution Assessment (Ask First!)

🎯 关键提示:项目演进评估(首先询问!)

1. Has your project stage evolved since the last update?
a) Same Stage - Still in [current stage], just adding features
b) Stage Evolution - Moved from [current] to next stage
c) Major Pivot - Significant change in direction or purpose
d) Help Me Assess - Let's review current state together
2. Have your development priorities changed?
Based on your current stage, are these still your priorities?
[Show current DO/DON'T lists from
.claude/skills/3-project-status.mdc
]
a) Same Priorities - These still reflect our focus
b) Adjusted Priorities - Some changes needed (please specify)
c) New Focus Areas - Different priorities based on learnings
d) Stage-Based Change - Priorities changed due to stage evolution
1. 自上次更新以来,项目阶段是否有演进?
a) 阶段未变 - 仍处于[当前阶段],仅在添加功能
b) 阶段演进 - 从[当前阶段]进入下一阶段
c) 重大转向 - 方向或用途发生重大变化
d) 协助评估 - 让我们一起回顾当前状态
2. 开发优先级是否有变化?
根据当前阶段,这些优先级是否仍然适用?
[显示来自
.claude/skills/3-project-status.mdc
的当前DO/DON'T列表]
a) 优先级未变 - 这些仍然符合我们的重点
b) 优先级调整 - 需要一些变更(请说明)
c) 新聚焦领域 - 根据经验调整为不同的优先级
d) 基于阶段的变更 - 因阶段演进导致优先级变化

📊 Change Identification Questions

📊 变更识别问题

3. What major features have been added?
Please describe any significant new capabilities, modules, or user-facing features added since the last update.
4. Have any core user flows changed?
a) Authentication/Authorization - Login, permissions, security
b) Main User Journey - Primary application workflow
c) Data Management - How users create/edit/delete data
d) Integration Points - External service connections
e) None/Minor Only - No significant flow changes
5. What has been removed or deprecated?
List any features, integrations, or capabilities that have been removed or are being phased out.
6. Have you integrated new external services?
a) Payment Processing - Stripe, PayPal, etc.
b) Communication - Email, SMS, notifications
c) Analytics/Monitoring - Tracking, logging services
d) AI/ML Services - LLMs, image processing, etc.
e) Other - Please specify
f) None - No new integrations
3. 新增了哪些主要功能?
请描述自上次更新以来添加的任何重要新功能、模块或用户可用功能。
4. 核心用户流程是否有变化?
a) 认证/授权 - 登录、权限、安全
b) 主要用户旅程 - 核心应用流程
c) 数据管理 - 用户创建/编辑/删除数据的方式
d) 集成点 - 外部服务连接
e) 无/仅细微变化 - 无重大流程变更
5. 哪些功能已被移除或弃用?
列出任何已被移除或逐步淘汰的功能、集成或能力。
6. 是否集成了新的外部服务?
a) 支付处理 - Stripe、PayPal等
b) 通信服务 - 邮件、短信、通知
c) 分析/监控 - 跟踪、日志服务
d) AI/ML服务 - 大语言模型、图像处理等
e) 其他 - 请说明
f) - 无新集成

🚀 Future Direction Questions

🚀 未来方向问题

7. How has user feedback influenced changes?
Describe any significant pivots or adjustments made based on user feedback or usage patterns.
8. What are your updated success metrics?
Have your KPIs or success measurements changed? Current focus:
  • User growth targets?
  • Revenue goals?
  • Engagement metrics?
  • Performance benchmarks?
9. What's the next major milestone?
a) Feature Release - Specific new capability
b) Scale Milestone - User/revenue target
c) Technical Goal - Performance, security, architecture
d) Business Goal - Partnerships, funding, market expansion
7. 用户反馈如何影响了变更?
描述基于用户反馈或使用模式做出的任何重大转向或调整。
8. 更新后的成功指标是什么?
关键绩效指标(KPI)或成功衡量标准是否有变化?当前重点:
  • 用户增长目标?
  • 收入目标?
  • 参与度指标?
  • 性能基准?
9. 下一个主要里程碑是什么?
a) 功能发布 - 特定的新能力
b) 规模里程碑 - 用户/收入目标
c) 技术目标 - 性能、安全、架构
d) 业务目标 - 合作伙伴关系、融资、市场拓展

Update Strategy

更新策略

Incremental Updates

增量更新

  • Preserve: Keep accurate existing content
  • Enhance: Add new information to existing sections
  • Replace: Update outdated or incorrect information
  • Remove: Mark deprecated features appropriately
  • 保留: 保留准确的现有内容
  • 增强: 在现有章节中添加新信息
  • 替换: 更新过时或不正确的信息
  • 移除: 适当标记弃用功能

Change Documentation

变更记录

  • New Features: Add to relevant feature categories
  • Modified Flows: Update user journey descriptions
  • Architecture Changes: Reflect in system architecture section
  • Business Evolution: Update goals and success metrics
  • 新增功能: 添加到相关功能类别中
  • 修改的流程: 更新用户旅程描述
  • 架构变更: 在系统架构部分体现
  • 业务演进: 更新目标和成功指标

Consistency Maintenance

一致性维护

  • Keep the same professional, accessible tone
  • Maintain technology-agnostic descriptions
  • Focus on WHAT not HOW
  • Preserve document structure
  • 保持相同的专业、易懂语气
  • 保持技术无关的描述
  • 聚焦于WHAT而非HOW
  • 保留文档结构

Document Update Areas

文档更新区域

Always Review:

需始终检查的区域:

  1. Introduction
    • Update if purpose or audience has shifted
    • Reflect any pivot in value proposition
  2. Core Features
    • Add new feature categories if needed
    • Update existing features with enhancements
    • Mark removed features as deprecated
  3. User Experience
    • Update user journeys with new flows
    • Add new user personas if applicable
    • Reflect UI/UX improvements
  4. System Architecture
    • Add new integrations
    • Update data flow diagrams
    • Reflect new security patterns
  5. Business Logic
    • Update rules and workflows
    • Reflect new validation requirements
    • Document new business constraints
  6. Future Considerations
    • Update roadmap based on progress
    • Add new planned features
    • Reflect lessons learned
  1. 引言
    • 若目的或受众发生变化则更新
    • 反映价值主张的任何转向
  2. 核心功能
    • 必要时添加新的功能类别
    • 更新现有功能的增强内容
    • 将移除的功能标记为弃用
  3. 用户体验
    • 更新用户旅程以包含新流程
    • 适用时添加新的用户角色
    • 反映UI/UX改进
  4. 系统架构
    • 添加新的集成
    • 更新数据流图
    • 反映新的安全模式
  5. 业务逻辑
    • 更新规则和工作流
    • 反映新的验证要求
    • 记录新的业务约束
  6. 未来考量
    • 根据进展更新路线图
    • 添加新的计划功能
    • 反映所学经验教训

Execution Steps

执行步骤

1. Start with Analysis

1. 从分析开始

bash
undefined
bash
undefined

Check when document was last updated

Check when document was last updated

stat -f "%Sm" .claude/skills/1-app-design-document.mdc
stat -f "%Sm" .claude/skills/1-app-design-document.mdc

Review recent commits for feature changes

Review recent commits for feature changes

git log --oneline --since="30 days ago" | head -20

**Think deeply about:** "What has fundamentally changed in this application? How have new features altered the original vision? What patterns indicate architectural evolution?"
git log --oneline --since="30 days ago" | head -20

**深入思考:** "这个应用发生了哪些根本性变化?新功能如何改变了最初的愿景?哪些模式表明了架构演进?"

2. Interactive Q&A

2. 交互式问答

  • MUST ASK PROJECT STAGE FIRST
  • Present all questions clearly
  • Wait for complete responses
  • 必须首先询问项目阶段问题
  • 清晰呈现所有问题
  • 等待完整回复

3. Update Project Status (if needed)

3. 更新项目状态(如有需要)

If stage or priorities changed, update both:
markdown
undefined
若阶段或优先级发生变化,同时更新两者:
markdown
undefined

In
.claude/skills/3-project-status.mdc

In
.claude/skills/3-project-status.mdc

Project Status

Project Status

Current Stage: [New Stage]
Current Stage: [New Stage]

DO Care About (Production-Ready Foundation)

DO Care About (Production-Ready Foundation)

[Updated priorities]
[Updated priorities]

DO NOT Care About (Skip for Velocity)

DO NOT Care About (Skip for Velocity)

[Updated items to skip]
undefined
[Updated items to skip]
undefined

4. Sync Document

4. 同步文档

  • Make targeted updates
  • Preserve document quality
  • Add version note if helpful:
markdown
<!-- Last updated: [date] - Major changes: [summary] -->
  • 进行针对性更新
  • 保留文档质量
  • 如有帮助可添加版本说明:
markdown
<!-- Last updated: [date] - Major changes: [summary] -->

5. Save and Backup

5. 保存并备份

bash
undefined
bash
undefined

Optional: Create backup

Optional: Create backup

cp .claude/skills/1-app-design-document.mdc .claude/skills/1-app-design-document.backup.mdc
cp .claude/skills/1-app-design-document.mdc .claude/skills/1-app-design-document.backup.mdc

Save updated document

Save updated document

Overwrite .claude/skills/1-app-design-document.mdc

Overwrite .claude/skills/1-app-design-document.mdc

undefined
undefined

Key Principles

核心原则

DO:

需执行:

  • Preserve Quality: Maintain document's professional tone
  • Incremental Updates: Don't rewrite unnecessarily
  • Clear Changes: Make updates obvious and well-integrated
  • User Focus: Keep emphasis on user value
  • Stage Awareness: Align with current project maturity
  • 保留质量: 保持文档的专业语气
  • 增量更新: 不必要时不要重写
  • 清晰变更: 使更新内容清晰且易于整合
  • 用户聚焦: 始终强调用户价值
  • 阶段感知: 与当前项目成熟度保持一致

DON'T:

请勿执行:

  • Complete Rewrite: Unless fundamentally pivoted
  • Technical Details: Maintain high-level focus
  • Break Structure: Keep established organization
  • Lose History: Preserve context of major decisions
  • Skip Analysis: Always understand current state first
  • 完全重写: 除非发生根本性转向
  • 技术细节: 保持高层级聚焦
  • 破坏结构: 保留已确立的组织架构
  • 丢失历史: 保留重大决策的背景信息
  • 跳过分析: 始终先了解当前状态

Output

输出

  • Format: Markdown (
    .mdc
    )
  • Location:
    .claude/skills/
  • Filename:
    1-app-design-document.mdc
    (overwrites)
  • Backup: Suggest if major changes
  • 格式: Markdown(
    .mdc
  • 位置:
    .claude/skills/
  • 文件名:
    1-app-design-document.mdc
    (覆盖原文件)
  • 备份: 若有重大变更建议创建备份

Final Checklist

最终检查清单

  1. ✅ Read existing document completely
  2. ✅ Analyze codebase changes thoroughly
  3. ✅ Ask project stage question FIRST
  4. ✅ Update
    .claude/skills/3-project-status.mdc
    if stage/priorities changed
  5. ✅ Make incremental, targeted updates
  6. ✅ Preserve document quality and tone
  7. ✅ Suggest backup for major changes
  8. ✅ Consider 2-tech-stack.mdc updates if needed
  1. ✅ 完整阅读现有文档
  2. ✅ 全面分析代码库变更
  3. ✅ 首先询问项目阶段问题
  4. ✅ 若阶段/优先级发生变化,更新
    .claude/skills/3-project-status.mdc
  5. ✅ 进行增量、针对性更新
  6. ✅ 保留文档质量和语气
  7. ✅ 若有重大变更,建议创建备份
  8. ✅ 如有需要,考虑更新2-tech-stack.mdc