docs-ai-prd

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

PRDs & Project Context

PRD与项目上下文

Create product requirements and project context that humans and coding assistants can execute effectively.
Two capabilities:
  1. PRDs & Specs - Requirements, specs, stories, acceptance criteria
  2. 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.
创建人类和代码助手都能有效执行的产品需求和项目上下文。
两大核心能力:
  1. PRD与规格说明 - 需求、规格、用户故事、验收标准
  2. 项目上下文 - 架构、约定、隐性知识(CLAUDE.md)
2026年1月现代最佳实践:上下文工程(正确的信息、正确的格式、正确的时机)、决策优先文档、带验收标准的可测试需求、含公式+时间范围+数据源的指标、跨工具可移植性。

Workflow (Use This Order)

工作流程(按此顺序使用)

  1. Pick the deliverable (PRD, AI PRD, tech spec, story map, CLAUDE.md).
  2. Gather inputs (problem evidence, users, constraints, dependencies, risks).
  3. Fill the template (write decisions first; keep requirements testable).
  4. Validate with checklists (requirements, edge cases, security/compliance as needed).
  5. Hand off with next actions (implementation plan, owners, open questions).
  1. 选择交付物(PRD、AI PRD、技术规格、故事地图、CLAUDE.md)。
  2. 收集输入信息(问题证据、用户群体、约束条件、依赖关系、风险)。
  3. 填写模板(先写决策;确保需求可测试)。
  4. 用检查清单验证(需求、边缘情况、按需验证安全/合规)。
  5. 移交并明确后续行动(实施计划、负责人、待解决问题)。

Quick Reference

快速参考

PRDs & Specs

PRD与规格说明

TaskTemplate
PRD creationassets/prd/prd-template.md
Tech specassets/spec/tech-spec-template.md
Planning checklistassets/planning/planning-checklist.md
Story mappingassets/stories/story-mapping-template.md
Gherkin/BDDassets/stories/gherkin-example-template.md
AI PRDassets/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/BDDassets/stories/gherkin-example-template.md
AI PRDassets/prd/ai-prd-template.md

Project Context (CLAUDE.md)

项目上下文(CLAUDE.md)

Context TypeTemplatePriority
Architectureassets/architecture-context.mdCritical
Conventionsassets/conventions-context.mdHigh
Key Filesassets/key-files-context.mdCritical
Minimal Startassets/minimal-claudemd.md5-min
Cross-Toolassets/cross-tool-context.mdMulti-tool

上下文类型模板优先级
架构assets/architecture-context.md关键
约定assets/conventions-context.md
核心文件assets/key-files-context.md关键
最简入门assets/minimal-claudemd.md5分钟完成
跨工具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/BDD

text
用户需求:
    ├─► AI辅助编码?
    │   ├─ 非简单项目(>3个文件)? → 规划检查清单 + 智能会话
    │   └─ 简单项目(<3个文件)? → 直接实现
    ├─► 项目入职?
    │   ├─ 不熟悉代码库? → 生成CLAUDE.md
    │   └─ 快速了解上下文? → 最简CLAUDE.md
    └─► 传统PRD?
        ├─ 产品需求? → PRD模板
        ├─ AI功能? → AI PRD模板
        └─ 验收标准? → Gherkin/BDD

Cross-Tool Context Files

跨工具上下文文件

ToolLocationNotes
Claude Code
CLAUDE.md
,
.claude/
Auto-loaded
Cursor
.cursor/rules/
Project rules
Copilot
.github/copilot-instructions.md
Workspace context
Generic
AGENTS.md
Tool-agnostic

工具位置说明
Claude Code
CLAUDE.md
,
.claude/
自动加载
Cursor
.cursor/rules/
项目规则
Copilot
.github/copilot-instructions.md
工作区上下文
通用型
AGENTS.md
工具无关

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

资源

ResourcePurpose
references/agentic-coding-best-practices.mdAI coding patterns
references/requirements-checklists.mdPRD validation
references/traditional-prd-writing.mdClassic PRD format
references/architecture-extraction.mdMining architecture
references/convention-mining.mdExtracting conventions
references/tribal-knowledge-recovery.mdGit history analysis
references/docs-audit-commands.mdAudit shell commands
data/sources.jsonCurated external sources
资源用途
references/agentic-coding-best-practices.mdAI编码模式
references/requirements-checklists.mdPRD验证
references/traditional-prd-writing.md经典PRD格式
references/architecture-extraction.md挖掘架构信息
references/convention-mining.md提取约定规则
references/tribal-knowledge-recovery.mdGit历史分析
references/docs-audit-commands.md审计Shell命令
data/sources.json精选外部资源

Templates

模板

CategoryTemplates
PRDsprd-template, ai-prd-template, tech-spec-template
Planningplanning-checklist, agentic-session-template
Storiesstory-mapping-template, gherkin-example-template
Contextarchitecture, conventions, key-files, minimal-claudemd
Stack-specificnodejs-context, python-context, react-context, go-context
分类模板
PRDprd-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

相关技能

SkillPurpose
docs-codebaseREADME, API docs, ADRs
qa-docs-coverageDocumentation gaps
product-managementProduct strategy
software-architecture-designSystem design
技能用途
docs-codebaseREADME、API文档、ADR
qa-docs-coverage文档缺口检查
product-management产品策略
software-architecture-design系统设计