Skip to content

模板系统总览

Claude Code企业级文档模板系统,提供标准化的文档创建和项目管理模板。

核心功能

  • 标准化文档生成: 12个专业模板涵盖项目全生命周期
  • 智能交互式创建: 高级引导式文档生成
  • 版本化管理: 统一的版本控制和变更跟踪
  • 代理集成: 与AI代理系统无缝协作
  • 企业级品质: 满足企业项目管理标准

使用语法

模板系统通过代理自动激活,也可手动指定使用:

bash
# 通过代理自动选择合适模板
/task create-prd --project "我的项目"

# 手动指定模板
/implement --template prd-tmpl --project "项目名称"

模板清单

架构设计模板

通用架构模板 (architecture-tmpl.yaml)

  • 用途: 标准项目架构设计
  • 输出: docs/architecture.md
  • 适用场景: 绿地项目架构规划
  • 包含章节:
    • 技术栈选择与决策
    • 系统架构和组件设计
    • 数据模型和API规格
    • 安全策略和编码标准
    • 测试策略和部署架构

棕地架构模板 (brownfield-architecture-tmpl.yaml)

  • 用途: 现有项目增强架构设计
  • 输出: docs/architecture.md
  • 适用场景: 对现有系统进行重大功能增强
  • 核心特性:
    • 深度现有系统分析
    • 增强功能集成策略
    • 向后兼容性保证
    • 渐进式部署计划

前端架构模板 (front-end-architecture-tmpl.yaml)

  • 用途: 前端专项架构设计
  • 输出: docs/ui-architecture.md
  • 适用场景: 复杂前端应用或UI系统设计
  • 专业特性:
    • 框架和启动模板选择
    • 组件标准和状态管理
    • API集成和路由设计
    • 样式指南和测试要求

全栈架构模板 (fullstack-architecture-tmpl.yaml)

  • 用途: 全栈应用统一架构设计
  • 输出: docs/architecture.md
  • 适用场景: 前后端紧密集成的现代应用
  • 统一特性:
    • 前后端技术栈协调
    • 统一项目结构设计
    • 端到端工作流程
    • 全栈开发和部署策略

产品文档模板

产品需求文档模板 (prd-tmpl.yaml)

  • 用途: 标准产品需求文档创建
  • 输出: docs/prd.md
  • 适用场景: 新产品或功能需求规划
  • 完整流程:
    • 目标和背景分析
    • 功能和非功能需求
    • UI/UX设计目标
    • 技术假设和约束
    • Epic和Story详细规划

棕地PRD模板 (brownfield-prd-tmpl.yaml)

  • 用途: 现有项目增强需求文档
  • 输出: docs/prd.md
  • 适用场景: 对现有产品进行重大功能增强
  • 增强特性:
    • 现有项目深度分析
    • 兼容性需求定义
    • 集成验证标准
    • 风险评估和缓解策略

前端规格模板 (front-end-spec-tmpl.yaml)

  • 用途: UI/UX详细规格说明
  • 输出: docs/front-end-spec.md
  • 适用场景: 复杂用户界面设计规划
  • 设计要素:
    • UX目标和设计原则
    • 信息架构和用户流程
    • 组件库和设计系统
    • 响应式和无障碍设计

市场分析模板

市场研究模板 (market-research-tmpl.yaml)

  • 用途: 全面市场研究报告
  • 输出: docs/market-research.md
  • 适用场景: 产品市场定位和机会分析
  • 研究框架:
    • 市场规模和增长分析(TAM/SAM/SOM)
    • 客户分析和Jobs-to-be-Done
    • 行业分析(波特五力模型)
    • 机会评估和策略建议

竞品分析模板 (competitor-analysis-tmpl.yaml)

  • 用途: 深度竞争对手分析
  • 输出: docs/competitor-analysis.md
  • 适用场景: 竞争策略制定和市场定位
  • 分析维度:
    • 竞争格局和对手画像
    • 功能对比矩阵
    • SWOT比较分析
    • 战略建议和监控计划

项目管理模板

项目简介模板 (project-brief-tmpl.yaml)

  • 用途: 项目启动和背景文档
  • 输出: docs/brief.md
  • 适用场景: 项目发现和初期规划
  • 核心内容:
    • 执行摘要和问题陈述
    • 解决方案和目标用户
    • MVP范围和成功指标
    • 技术考量和约束条件

用户故事模板 (story-tmpl.yaml)

  • 用途: 详细用户故事文档
  • 输出: docs/stories/...md
  • 适用场景: 敏捷开发故事管理
  • 管理功能:
    • 故事状态追踪
    • 验收标准定义
    • 任务分解和开发记录
    • QA结果和变更日志

头脑风暴输出模板 (brainstorming-output-tmpl.yaml)

  • 用途: 头脑风暴会议结果整理
  • 输出: docs/brainstorming-session-results.md
  • 适用场景: 创意会议和战略研讨
  • 结构化输出:
    • 会议技巧和想法生成
    • 想法分类和优先级排序
    • 行动计划和后续跟进

使用场景

新项目启动流程

项目构思 → 头脑风暴模板 → 项目简介模板 → 市场研究/竞品分析 

PRD模板 → 前端规格模板(如需要) → 架构模板 → 用户故事模板

现有项目增强流程

现有项目分析 → 棕地PRD模板 → 棕地架构模板 → 用户故事模板

市场和产品研究流程

市场研究模板 → 竞品分析模板 → 项目简介模板 → PRD模板

高级特性

智能引导系统

  • 高级引导: 基于项目类型智能推荐问题和选项
  • 上下文感知: 根据已有信息自动填充相关章节
  • 验证检查: 内置验证规则确保文档完整性和一致性

版本管理

  • 变更日志: 每个模板都包含详细的变更追踪表格
  • 版本标识: 统一的版本号管理系统(当前v2.0)
  • 向前兼容: 支持模板升级和迁移

工作流集成

  • 交互模式: 支持交互式和非交互式文档生成
  • 代理协作: 与PM、架构师、UX专家等代理无缝配合
  • 输出标准化: 统一的Markdown格式和文件命名规范

最佳实践

1. 模板选择指南

  • 新项目: 使用标准模板系列 (project-brief → prd → architecture)
  • 现有项目增强: 使用棕地模板系列 (brownfield-prd → brownfield-architecture)
  • UI密集项目: 添加front-end-spec和front-end-architecture模板
  • 全栈项目: 考虑使用fullstack-architecture替代分离的架构模板

2. 文档创建顺序

  1. 发现阶段: 项目简介 → 市场研究 → 竞品分析
  2. 规划阶段: PRD → 前端规格(如需要) → 架构设计
  3. 执行阶段: 用户故事 → 开发实施

3. 质量保证

  • 完整性检查: 使用内置检查清单验证文档完整性
  • 一致性验证: 确保所有文档间的信息一致性
  • 定期更新: 随项目进展及时更新相关文档

4. 团队协作

  • 角色明确: 不同模板由相应专业角色负责
  • 审查流程: 建立文档审查和批准机制
  • 知识共享: 通过文档实现团队知识传递

模板系统总览 - 企业级文档标准化解决方案

Claude Code 使用指南