dev-docslisted

# 开发文档自动化工具 > **多平台支持**: 本文件可作为 Cursor IDE 的 Skill (`~/.cursor/skills/`) 或 Claude Code 的 Skill (`~/.claude/skills/`) 使用。 本技能帮助在开发过程中自动生成和维护项目文档，确保文档与代码保持同步。 ## 核心工作流 ### 流程 1：新功能开发完成 → 生成文档 当完成一个新功能的开发后，执行以下步骤： 1. **分析代码变更** - 识别新增/修改的文件 - 提取新增的 API 接口 - 识别数据模型变更 2. **生成需求文档** → `docs/requirements/REQ-{feature_name}.md` 3. **更新 API 文档** → `docs/api/API.md` 4. **更新 CHANGELOG** → `docs/CHANGELOG.md` 5. **更新 API CHANGELOG** → `docs/api/API_CHANGELOG.md` ### 流程 2：代码更新 → 更新文档 当对现有功能进行修改后： 1. **识别变更类型** (Added/Changed/Fixed/Removed) 2. **更新对应的需求文档** 3. **更新 API 文档**（如有接口变更） 4. **追加 CHANGELOG 条目** --- ## 文档模板 ### 需求文档模板 (PRD) 文件位置：`docs/requirements/REQ-{feature_name}.md` ```markdown # {功能名称} - 需求文档 ## 文档信息 | 属性 | 值 | |------|-----| | 文档编号 | REQ-{编号} | | 版本 | v1.0 | | 创建日期 | {YYYY-MM-DD} | | 最后更新 | {YYYY-MM-DD} | | 作者 | {作者} | | 状态 | 草稿/评审中/已批准/已实现 | --- ## 1. 功能概述 ### 1.1 简要描述 {一句话描述该功能的核心目的} ### 1.2 关键词 {功能相关的关键术语} --- ## 2. 背景和目标 ### 2.1 背景 {为什么需要这个功能？解决什么问题？} ### 2.2 目标 - 目标 1：{具体可衡量的目标} - 目标 2：{具体可衡量的目标} ### 2.3 非目标 {明确声明此功能不做什么} --- ## 3. 功能需求 ### 3.1 用户故事 | 编号 | 角色 | 需求 | 价值 | |------|------|------|------| | US-01 | 作为{角色} | 我希望{功能} | 以便{价值} | ### 3.2 功能清单 | 编号 | 功能名称 | 优先级 | 描述 | |------|----------|--------|------| | F-01 | {功能名} | P0/P1/P2 | {详细描述} | ### 3.3 业务规则 - BR-01：{业务规则描述} --- ## 4. 非功能需求 ### 4.1 性能要求 - 响应时间：{具体指标} - 吞吐量：{具体指标} ### 4.2 安全要求 - {安全相关要求} ### 4.3 兼容性 - {浏览器/系统兼容性要求} --- ## 5. UI/交互设计 ### 5.1 页面布局 {描述或引用设计