dev-workflow

Five-step development process

Requirement understanding → Solution design → Code implementation → Code review → Bug fixing

Step 1: Identify the current step

Select the corresponding reference file to execute based on the user's needs:

Step	File	Trigger keywords
Requirement understanding	requirement.md	requirement analysis, understand requirements, organize requirements, help me sort out
Solution design	design.md	solution design, technical design, architecture design, how to implement
Code implementation	implementation.md	code implementation, start writing code, help me implement, write it
Code review	review.md	code review, Review, check code, see if there are any problems
Bug fixing	bug-fix.md	bug, error, crash, exception, not working, something went wrong, test failure

Step 2: Execution, output, and persistence

Read the complete process in the corresponding reference, execute it step by step, and output deliverables that meet the requirements of that stage.

Automatic persistence (must be written by default):

• Requirement understanding：docs/<feature>/01-需求理解.md
• Solution design：docs/<feature>/02-方案设计.md

Optional persistence (not written by default, only written when the user explicitly requests it):

• Code review：docs/<feature>/03-代码审查.md
• Bug fixing：docs/<feature>/04-bug修复.md

Persistence rules:

• The directory is under the current working directory docs/ , create it if it does not exist
• Divide into subdirectories by feature: if a feature can be identified (such as login, testing, deployment, etc.), it must be written to docs/<feature>/, even if there is only one feature, do not write to the root directory; when multiple features are involved, create a subdirectory for each, and all documents for the same feature go into the same subdirectory
• If the feature cannot be identified or the content is cross-feature and global (such as overall architecture design): write to docs/通用/
• <feature> Use a stable identifier (it is recommended to use the English feature name or code directory name/package name, such as login、deploy, avoid mixing synonyms)
• Evolutionary update (do not append): the main file is always the latest complete version, with the structure # 文档标题 → ## 修订记录(table: version | date | summary) → the complete body of this update
• First write: create the file, write the revision record to v1 | YYYY-MM-DD HH:mm | 初版
• Write again: first move the entire old file into docs/<feature>/archive/<原文件名>-v<N>-<YYYYMMDD>.md(for multiple archives on the same day, add an hour-minute suffix), then rewrite the main file, and add a new row to the revision record table (the version number increments, and the summary is a one-sentence summary of the changes)
• If the user explicitly specifies another file path, write to the user-specified path first
• Optionally maintain docs/功能索引.md to record the mapping between feature names and document paths

Notes

• After each step is completed, prompt the user to proceed to the next stage
• When upstream is missing: prompt the user to complete the prerequisite steps first, or briefly collect key information and then continue