docs-ai-prd
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChinesePRDs & Project Context
PRD与项目上下文
Create product requirements and project context that humans and coding assistants can execute effectively.
Two capabilities:
- PRDs & Specs - Requirements, specs, stories, acceptance criteria
- Project Context - Architecture, conventions, tribal knowledge (CLAUDE.md)
Modern Best Practices (Jan 2026): Context engineering (right info, right format, right time), decision-first docs, testable requirements with acceptance criteria, metrics with formula + timeframe + data source, cross-tool portability.
创建人类和代码助手都能有效执行的产品需求和项目上下文。
两大核心能力:
- PRD与规格说明 - 需求、规格、用户故事、验收标准
- 项目上下文 - 架构、约定、隐性知识(CLAUDE.md)
2026年1月现代最佳实践:上下文工程(正确的信息、正确的格式、正确的时机)、决策优先文档、带验收标准的可测试需求、含公式+时间范围+数据源的指标、跨工具可移植性。
Workflow (Use This Order)
工作流程(按此顺序使用)
- Pick the deliverable (PRD, AI PRD, tech spec, story map, CLAUDE.md).
- Gather inputs (problem evidence, users, constraints, dependencies, risks).
- Fill the template (write decisions first; keep requirements testable).
- Validate with checklists (requirements, edge cases, security/compliance as needed).
- Hand off with next actions (implementation plan, owners, open questions).
- 选择交付物(PRD、AI PRD、技术规格、故事地图、CLAUDE.md)。
- 收集输入信息(问题证据、用户群体、约束条件、依赖关系、风险)。
- 填写模板(先写决策;确保需求可测试)。
- 用检查清单验证(需求、边缘情况、按需验证安全/合规)。
- 移交并明确后续行动(实施计划、负责人、待解决问题)。
Quick Reference
快速参考
PRDs & Specs
PRD与规格说明
| Task | Template |
|---|---|
| PRD creation | assets/prd/prd-template.md |
| Tech spec | assets/spec/tech-spec-template.md |
| Planning checklist | assets/planning/planning-checklist.md |
| Story mapping | assets/stories/story-mapping-template.md |
| Gherkin/BDD | assets/stories/gherkin-example-template.md |
| AI PRD | assets/prd/ai-prd-template.md |
| 任务 | 模板 |
|---|---|
| PRD创建 | assets/prd/prd-template.md |
| 技术规格 | assets/spec/tech-spec-template.md |
| 规划检查清单 | assets/planning/planning-checklist.md |
| 故事地图 | assets/stories/story-mapping-template.md |
| Gherkin/BDD | assets/stories/gherkin-example-template.md |
| AI PRD | assets/prd/ai-prd-template.md |
Project Context (CLAUDE.md)
项目上下文(CLAUDE.md)
| Context Type | Template | Priority |
|---|---|---|
| Architecture | assets/architecture-context.md | Critical |
| Conventions | assets/conventions-context.md | High |
| Key Files | assets/key-files-context.md | Critical |
| Minimal Start | assets/minimal-claudemd.md | 5-min |
| Cross-Tool | assets/cross-tool-context.md | Multi-tool |
| 上下文类型 | 模板 | 优先级 |
|---|---|---|
| 架构 | assets/architecture-context.md | 关键 |
| 约定 | assets/conventions-context.md | 高 |
| 核心文件 | assets/key-files-context.md | 关键 |
| 最简入门 | assets/minimal-claudemd.md | 5分钟完成 |
| 跨工具 | assets/cross-tool-context.md | 多工具兼容 |
Decision Tree
决策树
text
User needs:
├─► AI-Assisted Coding?
│ ├─ Non-trivial (>3 files)? → Planning checklist + agentic session
│ └─ Simple (<3 files)? → Direct implementation
│
├─► Project Onboarding?
│ ├─ New to codebase? → Generate CLAUDE.md
│ └─ Quick context? → Minimal CLAUDE.md
│
└─► Traditional PRD?
├─ Product requirements? → PRD template
├─ AI feature? → AI PRD template
└─ Acceptance criteria? → Gherkin/BDDtext
用户需求:
├─► AI辅助编码?
│ ├─ 非简单项目(>3个文件)? → 规划检查清单 + 智能会话
│ └─ 简单项目(<3个文件)? → 直接实现
│
├─► 项目入职?
│ ├─ 不熟悉代码库? → 生成CLAUDE.md
│ └─ 快速了解上下文? → 最简CLAUDE.md
│
└─► 传统PRD?
├─ 产品需求? → PRD模板
├─ AI功能? → AI PRD模板
└─ 验收标准? → Gherkin/BDDCross-Tool Context Files
跨工具上下文文件
| Tool | Location | Notes |
|---|---|---|
| Claude Code | | Auto-loaded |
| Cursor | | Project rules |
| Copilot | | Workspace context |
| Generic | | Tool-agnostic |
| 工具 | 位置 | 说明 |
|---|---|---|
| Claude Code | | 自动加载 |
| Cursor | | 项目规则 |
| Copilot | | 工作区上下文 |
| 通用型 | | 工具无关 |
CLAUDE.md / AGENTS.md Guidance
CLAUDE.md / AGENTS.md 指南
- Start minimal: assets/minimal-claudemd.md
- Add only what’s needed: assets/architecture-context.md, assets/conventions-context.md, assets/key-files-context.md, assets/dependencies-context.md, assets/tribal-knowledge-context.md
- Keep it executable: commands must run; include no secrets; prefer file paths over pasted code
- 从最简版本开始: assets/minimal-claudemd.md
- 仅添加必要内容: assets/architecture-context.md, assets/conventions-context.md, assets/key-files-context.md, assets/dependencies-context.md, assets/tribal-knowledge-context.md
- 确保可执行: 命令必须能运行; 不包含敏感信息; 优先使用文件路径而非粘贴代码
Do / Avoid
注意事项
Do
建议做
- Start with executive summary (decision, users, scope, success)
- Define acceptance criteria in testable language
- Keep requirements unambiguous (must/should/may)
- Link to supporting docs instead of pasting
- 以执行摘要开头(决策、用户群体、范围、成功指标)
- 用可测试的语言定义验收标准
- 确保需求明确无误(使用必须/应该/可以)
- 链接到支持文档而非直接粘贴内容
Avoid
避免做
- Vague requirements ("fast", "easy") without definitions
- Mixing draft notes and final requirements
- Metrics without measurement plan
- Docs with no owner or review cadence
- 模糊需求(如“快”、“简单”)而不给出定义
- 混合草稿笔记与最终需求
- 没有测量计划的指标
- 没有负责人或评审周期的文档
Context Extraction
上下文提取
Use:
- references/architecture-extraction.md for components/data flows
- references/convention-mining.md for naming/patterns
- references/tribal-knowledge-recovery.md for git-history “why”
- references/docs-audit-commands.md for audit commands and tool fallbacks
使用以下资源:
- references/architecture-extraction.md 用于组件/数据流
- references/convention-mining.md 用于命名/模式
- references/tribal-knowledge-recovery.md 用于从Git历史中挖掘“原因”
- references/docs-audit-commands.md 用于审计命令和工具备选方案
Quality Checklist
质量检查清单
PRD Quality
PRD质量
- Clear problem statement
- Measurable success criteria
- Unambiguous acceptance criteria
- Edge cases documented
- AI can execute without clarification
- 清晰的问题陈述
- 可衡量的成功标准
- 明确的验收标准
- 记录边缘情况
- AI无需额外澄清即可执行
CLAUDE.md Quality
CLAUDE.md质量
- Architecture reflects actual structure
- Key files exist at listed locations
- Conventions match actual patterns
- Commands actually work
- No sensitive information
- 架构反映实际结构
- 核心文件存在于列出的位置
- 约定与实际模式匹配
- 命令可正常运行
- 无敏感信息
Resources
资源
| Resource | Purpose |
|---|---|
| references/agentic-coding-best-practices.md | AI coding patterns |
| references/requirements-checklists.md | PRD validation |
| references/traditional-prd-writing.md | Classic PRD format |
| references/architecture-extraction.md | Mining architecture |
| references/convention-mining.md | Extracting conventions |
| references/tribal-knowledge-recovery.md | Git history analysis |
| references/docs-audit-commands.md | Audit shell commands |
| data/sources.json | Curated external sources |
| 资源 | 用途 |
|---|---|
| references/agentic-coding-best-practices.md | AI编码模式 |
| references/requirements-checklists.md | PRD验证 |
| references/traditional-prd-writing.md | 经典PRD格式 |
| references/architecture-extraction.md | 挖掘架构信息 |
| references/convention-mining.md | 提取约定规则 |
| references/tribal-knowledge-recovery.md | Git历史分析 |
| references/docs-audit-commands.md | 审计Shell命令 |
| data/sources.json | 精选外部资源 |
Templates
模板
| Category | Templates |
|---|---|
| PRDs | prd-template, ai-prd-template, tech-spec-template |
| Planning | planning-checklist, agentic-session-template |
| Stories | story-mapping-template, gherkin-example-template |
| Context | architecture, conventions, key-files, minimal-claudemd |
| Stack-specific | nodejs-context, python-context, react-context, go-context |
| 分类 | 模板 |
|---|---|
| PRD | prd-template, ai-prd-template, tech-spec-template |
| 规划 | planning-checklist, agentic-session-template |
| 用户故事 | story-mapping-template, gherkin-example-template |
| 上下文 | architecture, conventions, key-files, minimal-claudemd |
| 特定技术栈 | nodejs-context, python-context, react-context, go-context |
Related Skills
相关技能
| Skill | Purpose |
|---|---|
| docs-codebase | README, API docs, ADRs |
| qa-docs-coverage | Documentation gaps |
| product-management | Product strategy |
| software-architecture-design | System design |
| 技能 | 用途 |
|---|---|
| docs-codebase | README、API文档、ADR |
| qa-docs-coverage | 文档缺口检查 |
| product-management | 产品策略 |
| software-architecture-design | 系统设计 |