敏捷设计文档生成
核心原则
1. MVP导向,避免过度设计
- 敏捷开发以快速迭代为目标,不需要考虑所有边界情况
- 专注于核心功能,次要功能可以后续迭代
- 不要为了"完整性"而添加不必要的功能
2. 基于现有技术栈
- 必须先读取项目配置文件(pyproject.toml、package.json等)了解技术栈
- 复用现有组件,避免重复造轮子
- 设计方案必须与当前技术栈兼容
3. 清晰阐述设计意图
- 明确本次设计解决的问题或提供的功能
- 使用mermaid时序图展示交互流程
- 针对每个功能点给出实现思路和关键方法
- 复杂逻辑使用mermaid实现流程
- 提供示例代码说明关键实现
4. 精炼文档,面向技术人员
- 读者是开发者和了解业务的产品人员
- 避免冗长的背景介绍和废话
- 先了解现有组件,避免重复设计
工作流程
第一步:前置分析
在生成设计文档之前,必须先完成以下分析:
1.1 了解项目背景
询问用户或分析项目:
- 项目背景?现在是什么系统,要做什么功能/模块?
[Description truncada. Veja o README completo no GitHub.]