项目文档生成技能
概述
本技能提供了一套完整的项目文档模板集合，帮助快速生成软件开发项目所需的各种文档。模板基于 DDD（领域驱动设计）和 COLA 架构思想，适用于从产品调研到项目运维的全生命周期。
关键词: 项目文档、PRD、需求文档、架构设计、技术文档、项目模板、文档生成、产品文档
核心功能
1. 产品阶段文档
- 产品调研模板 - 市场调研、用户调研、竞品分析
- 需求调研模板 - 需求收集、用户访谈、需求整理
- 技术调研模板 - 技术选型、技术可行性分析、技术对比
- 需求分析模板 - 需求拆解、优先级排序、需求评审
2. 设计阶段文档
- PRD文档模板 - 产品需求文档，包含功能需求、用户故事、验收标准
- 视觉与交互 DNA 规范模板 - 设计语言、交互规范、视觉规范
- UI 设计说明模板 - UI设计规范、组件库、设计系统
3. 技术设计文档
- 领域模型说明模板 - DDD领域模型、实体、值对象、聚合
- 系统架构设计模板 - 技术架构、系统架构、部署架构
- 技术细分模板 - 接口设计、数据库设计、技术实现细节
4. 测试与交付文档
- 功能提测模板 - 提测清单、测试环境、测试范围
- 测试结果模板 - 测试报告、缺陷统计、测试结论
- 上线通知模板 - 上线计划、上线检查清单、回滚方案
- 项目运维模板 - 运维手册、监控告警、故障处理
使用指南
快速生成文档
- 指定文档类型
使用项目文档生成技能，帮我生成一个 PRD 文档 - 指定项目信息
基于模板生成系统架构设计文档，项目名称是 partme-ai 教学平台 - 批量生成文档
为我的项目生成全套文档，包括 PRD、架构设计、技术文档
模板使用说明
所有模板文件位于 templates/ 目录下，包含以下14个模板：
1、产品调研模板.md- 产品调研阶段文档2、需求调研模板.md- 需求调研阶段文档3、技术调研模板.md- 技术调研阶段文档（技术选型、技术可行性分析）4、需求分析模板.md- 需求分析阶段文档5、PRD文档模板.md- 产品需求文档6、视觉与交互 DNA 规范模板.md- 设计规范文档7、UI 设计说明模板.md- UI设计文档8、领域模型说明模板.md- 领域模型文档9、系统架构设计模板.md- 系统架构文档10、技术细分模板.md- 技术实现文档11、功能提测模板.md- 提测文档12、测试结果模板.md- 测试报告13、上线通知模板.md- 上线文档14、项目运维模板.md- 运维文档
模板占位符说明
模板中使用 {} 包裹的内容为占位符，需要替换为实际内容：
{产品名称}- 产品名称{项目名称}- 项目名称{YYYY-MM-DD}- 日期格式{姓名}- 人员姓名- 其他
{}包裹的内容 - 根据上下文替换
文档生成流程
- 选择模板
- 根据项目阶段选择合适的模板 - 可以同时使用多个模板生成完整文档集
- 填写占位符
- 替换模板中的 {} 占位符 - 根据项目实际情况填写内容
- 定制化调整
- 根据项目特点调整模板结构 - 添加或删除不需要的章节
- 文档评审
- 与团队评审文档内容 - 根据反馈调整和完善
使用示例
示例 1: 生成 PRD 文档
用户: 使用项目文档生成技能，帮我生成一个 PRD 文档，产品名称是"智能教学助手"
AI: 我将基于 PRD 文档模板为您生成产品需求文档...示例 2: 生成架构设计文档
用户: 基于模板生成系统架构设计文档，项目名称是 partme-ai 教学平台，使用 Spring Boot 和 Vue 3
AI: 我将基于系统架构设计模板为您生成架构文档...示例 3: 生成完整文档集
用户: 为我的新项目生成全套文档，包括产品调研、PRD、架构设计和技术文档
AI: 我将为您生成以下文档：
1. 产品调研文档
2. PRD 文档
3. 系统架构设计文档
4. 技术细分文档
...模板特点
1. 标准化结构
- 统一的文档格式和结构
- 清晰的章节划分
- 完整的版本记录
2. DDD 和 COLA 架构
- 基于领域驱动设计思想
- 遵循 COLA 架构原则
- 支持微服务架构设计
3. 全生命周期覆盖
- 从产品调研到项目运维
- 涵盖所有关键阶段
- 文档之间相互关联
4. 易于定制
- 使用占位符便于替换
- 结构清晰便于调整
- 支持项目特定需求
注意事项
- 占位符替换: 确保所有
{}占位符都被正确替换 - 文档关联: 注意文档之间的关联关系，保持一致性
- 版本管理: 使用版本记录表跟踪文档变更
- 团队协作: 明确文档责任人，确保文档质量
- 持续更新: 根据项目进展及时更新文档内容
相关技能
documentation-builder- 通用文档构建技能code-generator- 代码生成技能mcp-builder- MCP 构建器技能