Token导航 LogoToken导航TokenDH.com
研究检索敏感数据github未标认证来源可访问许可证需确认审计提醒

prd-writing-guidePRD 写作指南

Agent Skill

用于辅助文档、README、Markdown、说明文和内容稿件的整理与改写。它适合让 Agent 提炼结构、补齐章节、统一术语、检查链接或把零散材料整理成可读文档。使用时应保留项目已有事实、命令和路径,不要把未确认的信息写成确定结论;涉及对外文案时,还需要控制语气,避免过度营销或夸大能力。

总安装

539

周安装

22

GitHub Stars

47

下载量

174
CodexClaudeCursorGemini CLI

安装说明

本站只整理中文说明和来源信息,不托管安装包,也不代用户安装。

GitHub

来源数

2

许可证

unknown

最后核验

2026-05-01

来源状态

来源可访问

安装方式

通过对话安装

复制提示词发给支持本地命令或 Skills 的 AI 助手,先确认命令和权限,再让它执行。

请帮我安装这个 Agent Skill:prd-writing-guide(PRD 写作指南)
来源仓库:https://github.com/okwinds/miscellany
仓库路径:skills/prd-writing-guide
安装命令:
npx skills add https://github.com/okwinds/miscellany --skill prd-writing-guide
安装前请先检查当前环境是否支持对应 CLI,并向我确认将要执行的命令、安装目录、联网范围和文件读写权限;确认后再执行。

命令行安装

复制命令到本机终端执行。该命令会通过 npx skills 从第三方来源获取 Skill;本站只展示命令,不托管安装包,也不自动执行。

skills.shnpx skills
npx skills add https://github.com/okwinds/miscellany --skill prd-writing-guide

简介

用于辅助文档、README、Markdown 和内容稿件的整理与改写,适合让 Agent 提炼结构、补齐章节或统一术语。

  • 适用于需要保留项目已有事实、避免写成确定结论的场景。
  • 通过 npx skills add 命令从指定 GitHub 仓库安装使用。
  • 涉及对外文案时应控制语气,避免过度营销或夸大能力。
  • prd-writing-guide 属于研究检索类 Skill,可作为该场景下的辅助能力补充。

SKILL.md

PRD Writing Guide

Overview

Write PRDs so complete that development teams can implement the entire product without asking a single clarifying question.

Skill Workflow Context

This skill is part of a 3-skill pipeline:

┌─────────────────┐     ┌─────────────────┐     ┌─────────────────┐
│ prd-writing-    │────►│ prd-to-         │     │ reverse-        │
│ guide           │     │ engineering-    │     │ engineering-    │
│                 │     │ spec            │     │ spec            │
│ [THIS SKILL]    │     │ PRD→Eng Spec   │     │ Code→Spec       │
└─────────────────┘     └─────────────────┘     └─────────────────┘

For AI Agent products, use `ai-agent-prd` instead (which extends this skill).

Handoff contract: The PRD this skill produces must be complete enough to pass prd-to-engineering-spec's Phase 0 validation without any ❌ items.

The PRD Quality Test

┌─────────────────────────────────────────────────────────────────┐
│                     The Developer Test                          │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Give your PRD to a developer who knows nothing about the      │
│  project. Can they:                                            │
│                                                                 │
│  □ Understand WHY we're building this?                         │
│  □ Know exactly WHAT to build (and what NOT to)?               │
│  □ Handle EVERY edge case without guessing?                    │
│  □ Write test cases for EVERY requirement?                     │
│  □ Estimate the work with confidence?                          │
│                                                                 │
│  If any answer is "no", your PRD is incomplete.                │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Core Principle: Eliminate Ambiguity

Every sentence in a PRD should have exactly one interpretation.

Ambiguous (❌)Precise (✅)
"Fast response time""API response < 200ms at P95"
"User-friendly interface""New users complete task in < 2 minutes without help"
"Handle errors gracefully""Show error toast with retry button; log to monitoring"
"Support large datasets""Handle up to 1M records with < 3s query time"
"Secure authentication""OAuth 2.0 with JWT, 24h token expiry, refresh tokens"

Quick Start

  1. Use the Discovery Questions to gather requirements
  2. Structure with the PRD Template
  3. Apply the Seven Lenses to each requirement
  4. Validate with the Completeness Checklist
  5. Verify with the Developer Handoff Checklist

Sensitive Information & Confidentiality (Required)

PRDs often contain information that should not leak outside your organization.

  • Do not paste secrets (API keys, tokens, passwords), customer PII, private endpoints, internal credentials, or confidential incident details into the PRD.
  • Use placeholders instead (e.g., OPENAI_API_KEY, [INTERNAL_URL], [CUSTOMER_ID]) and keep the real values in your secret manager / internal docs.
  • Before sharing a PRD externally (vendors, community, public issues), do a quick redaction pass:

- Replace internal URLs, private repo links, Jira/Linear IDs (if sensitive), and customer names. - Remove exact budgets/cost ceilings if they are confidential (or mark them as ranges).

Product Type Emphasis

Different products require different PRD emphasis. Adjust depth accordingly:

Product TypeEmphasizeDe-emphasize
Mobile/Web AppUX flows, states, responsive design, accessibilityInfrastructure details
API ServiceInterface contracts, data schemas, error codes, rate limitsUI/UX flows
Data PipelineData flow diagrams, transformation rules, quality checks, SLAsUser interaction
B2B SaaSMulti-tenancy, permissions, billing, onboardingConsumer UX patterns
AI-Powered ProductSee ai-features-prd.md; for Agents use ai-agent-prdN/A
Internal ToolWorkflow efficiency, integration with existing systemsScalability, marketing

Workflow Overview

Phase 1: Discovery ────► Understand the problem space
         ↓
Phase 2: Structure ────► Organize requirements systematically
         ↓
Phase 3: Detail ───────► Fill in every edge case
         ↓
Phase 4: Validate ─────► Check completeness
         ↓
Phase 5: Review ───────► Confirm with stakeholders & dev

Phase 1: Requirement Discovery

Goal: Ask the right questions to uncover all requirements.

The Discovery Framework

For every feature, systematically explore these dimensions:

1. Problem Space

  • What problem are we solving?
  • Who has this problem? How severe is it?
  • How do they solve it today? What's painful?
  • Why solve it now? What's the business driver?
  • How will we know we've solved it? (Metrics)

2. User Space

  • Who are ALL the users? (Don't forget admins, support, etc.)
  • What are their goals? Motivations?
  • What's their technical proficiency?
  • What context are they in? (Mobile? Rushed? Multitasking?)
  • How often will they use this?

3. Functional Space

  • What must the system DO?
  • What must it NOT do? (Explicit scope boundaries)
  • What's the MVP vs. nice-to-have?
  • What's the complete happy path?
  • What's every unhappy path?

4. Data Space

  • What data is needed?
  • Where does it come from?
  • How is it created, updated, deleted?
  • How long must it be retained?
  • Who can see/modify it?

5. Integration Space

  • What systems does this connect to?
  • What data is exchanged?
  • What if those systems are unavailable?
  • Who owns those systems?

6. Constraint Space

  • What are the performance requirements?
  • What are the security requirements?
  • What are the compliance requirements?
  • What are the budget/timeline constraints?
  • What existing systems/tech must we use?

Discovery Questions Template

See discovery-questions.md for a comprehensive question bank organized by domain.


Phase 2: Requirement Structure

Goal: Organize discovered requirements into a navigable, complete document.

PRD Structure

1. Executive Summary
   - One-paragraph problem statement
   - One-paragraph solution overview
   - Success metrics (3-5 key KPIs)

2. Background & Context
   - Business context
   - User research summary
   - Current state analysis
   - Competitive landscape (if relevant)

3. Goals & Non-Goals
   - What we're trying to achieve
   - What we're explicitly NOT doing
   - Success criteria

4. User Stories & Requirements
   - User personas
   - User stories with acceptance criteria
   - Functional requirements
   - Business rules

5. User Experience
   - User flows
   - Wireframes/mockups
   - Interaction specifications
   - Error states and messaging

6. Data Requirements
   - Data model (conceptual)
   - Data sources
   - Data lifecycle

7. Non-Functional Requirements
   - Performance
   - Security
   - Scalability
   - Accessibility

8. Dependencies & Integrations
   - System dependencies
   - External integrations
   - Team dependencies

9. Timeline & Milestones
   - Phases
   - Key milestones
   - Release criteria

10. Risks & Open Questions
    - Known risks
    - Assumptions
    - Unresolved questions

Appendix
    - Glossary
    - Reference documents
    - Revision history

See prd-template.md for the complete template with examples.


Phase 3: Requirement Detail

Goal: Make every requirement implementable without guesswork.

The Seven Lenses

Apply these seven lenses to EVERY requirement to ensure completeness:

┌──────────────────────────────────────────────────────────────────┐
│                        The Seven Lenses                          │
├──────────────────────────────────────────────────────────────────┤
│                                                                  │
│  1. HAPPY PATH: What happens when everything works?              │
│                                                                  │
│  2. SAD PATHS: What can go wrong? How do we handle each?         │
│                                                                  │
│  3. EDGE CASES: What are the boundary conditions?                │
│                                                                  │
│  4. PERMISSIONS: Who can do this? Who can't?                     │
│                                                                  │
│  5. STATE: What states exist? How do they transition?            │
│                                                                  │
│  6. DATA: What data flows in/out? Validation? Persistence?       │
│                                                                  │
│  7. FEEDBACK: What does the user see/hear at each step?          │
│                                                                  │
└──────────────────────────────────────────────────────────────────┘

Lens 1: Happy Path

Document the complete successful flow:

  • Entry point: How does the user start?
  • Each step: What exactly happens?
  • Exit point: How does it end?
  • Result: What's the outcome?

Lens 2: Sad Paths

For every step, ask "what if it fails?":

Failure TypeQuestions to Answer
User ErrorInvalid input → What message? Can they retry?
System ErrorServer fails → What message? Data preserved?
External FailureIntegration down → Fallback? Retry? Queue?
TimeoutOperation takes too long → Cancel? Retry?
ConcurrencyTwo users edit same thing → Who wins? Conflict resolution?

Lens 3: Edge Cases

CategoryExamples
EmptyZero items, blank input, no data yet
OneSingle item (different from multiple)
ManyMaximum items, pagination needed
BoundaryMin/max values, exactly at threshold
InvalidWrong type, out of range, special characters
TimingMidnight, timezone boundaries, DST transitions

Lens 4: Permissions

For every action, define:

QuestionExample Answer
Who can perform this?Admin, Owner, Member
Who cannot?Guest, Suspended users
What if unauthorized?403 page with "request access" button
How are permissions assigned?Owner grants via settings page
Can permissions be revoked?Yes, immediate effect

Lens 5: State

For entities with state, document:

State Machine Example:

┌───────┐    submit    ┌─────────┐    approve    ┌──────────┐
│ Draft │─────────────►│ Pending │──────────────►│ Approved │
└───────┘              └─────────┘               └──────────┘
    ▲                       │
    │         reject        │
    └───────────────────────┘

Transitions:
- Draft → Pending: Author submits. Requires: all fields filled.
- Pending → Approved: Admin approves. Side effect: notify author.
- Pending → Draft: Admin rejects. Requires: reason. Notify author.

Who can trigger:
- Submit: Author only
- Approve/Reject: Admin only

Lens 6: Data

For every piece of data:

AttributeSpecify
SourceWhere does it come from?
TypeString, number, date, enum, etc.
FormatRegex pattern, max length, allowed values
RequiredIs it optional? Conditionally required?
DefaultIf not provided, what value?
ValidationWhat makes it valid/invalid?
DisplayHow is it shown to users?
StorageHow long kept? Where stored?

Lens 7: Feedback

At every step, what does the user experience?

StepVisual FeedbackAudio/HapticMessage
LoadingSpinner on buttonNoneNone
SuccessGreen checkmarkSuccess chime"Saved successfully"
ErrorRed highlightError vibration"Email format invalid"
WarningYellow bannerNone"Unsaved changes will be lost"

Phase 4: Validation

Goal: Verify PRD completeness before handoff.

Completeness Checklist

Use completeness-checklist.md to verify every section.

Self-Review Questions

Before sharing the PRD, ask yourself:

  1. The Stranger Test: Could someone who knows nothing about this project implement it?
  2. The Negative Test: Have I defined what we're NOT doing?
  3. The Edge Case Test: Have I thought about empty, one, many, and error states?
  4. The Permission Test: Have I defined who can do what?
  5. The State Test: Have I mapped all states and transitions?
  6. The Failure Test: Have I documented what happens when things go wrong?
  7. The Metric Test: Have I defined how we'll measure success?
  8. The Test Case Test: Could QA write test cases from this?

Phase 5: Review

Goal: Confirm understanding with stakeholders and development team.

Stakeholder Review

Confirm with product/business stakeholders:

  • Problem statement accurate?
  • Success metrics agreed?
  • Scope and non-scope correct?
  • Priority order correct?
  • Timeline realistic?

Engineering Review

Walk through with development team:

  • Requirements understood?
  • Questions answered?
  • Technical feasibility confirmed?
  • Effort estimate possible?
  • Dependencies identified?
  • Risks surfaced?

The Question Log

Track every question asked during reviews:

QuestionAskerAnswerAdded to PRD?
"What if user has no email?"Dev"Email required for signup"✓ Section 4.2

Every question reveals a gap. Update the PRD with the answer.


Developer Handoff Checklist

Before declaring PRD "ready for development":

Content Completeness

  • Every user story has acceptance criteria
  • Every acceptance criterion is testable
  • All business rules documented with examples
  • All edge cases documented
  • All error handling specified
  • All states and transitions mapped
  • All permissions defined
  • All data fields specified with validation

Clarity

  • No ambiguous terms (search for: appropriate, reasonable, etc.)
  • No missing boundaries (search for: large, many, some)
  • No undefined references (every term in glossary or explained)

Testability

  • QA can write test cases for every requirement
  • Success criteria are measurable
  • Non-functional requirements are quantified

Alignment

  • Stakeholders have approved
  • Engineering has reviewed
  • Questions have been answered and documented

Common Pitfalls

See common-pitfalls.md for detailed guidance on avoiding these mistakes:

Pitfall 1: Solution Disguised as Problem

❌ "We need a dashboard" ✅ "Users can't see their key metrics at a glance. They currently export to Excel and manually calculate."

Pitfall 2: Vague Acceptance Criteria

❌ "User can easily create an account" ✅ "User completes signup in < 60 seconds with only email and password"

Pitfall 3: Missing Negative Cases

❌ "User can upload a file" ✅ "User can upload a file (max 10MB, types: PDF/DOC/DOCX). On invalid type: show error and list allowed types. On size exceeded: show error with current and max size."

Pitfall 4: Implicit Assumptions

❌ "Display user's orders" ✅ "Display user's orders (sorted by date descending, paginated at 20 per page, show last 90 days by default)"

Pitfall 5: Missing State Handling

❌ "Order can be cancelled" ✅ "Order can be cancelled by customer if status is Pending or Confirmed. Shipped orders cannot be cancelled (show 'Contact support'). Cancellation triggers: refund, inventory restore, email notification."


AI Feature Requirements

If your product includes AI features, see ai-features-prd.md for additional requirements:

  • Behavioral specification (what the AI should do)
  • Quality metrics (accuracy, relevance, etc.)
  • Failure handling (what if AI fails or produces bad output?)
  • User expectations (how to set appropriate expectations)
  • Feedback mechanisms (how users report issues)
  • Cost considerations (if applicable)

Resources

Scripts:

  • scripts/generate_prd_skeleton.sh - Generate PRD document structure

References:

  • references/prd-template.md - Complete PRD template with examples
  • references/discovery-questions.md - Comprehensive question bank
  • references/completeness-checklist.md - Validation checklist
  • references/common-pitfalls.md - Mistakes to avoid
  • references/ai-features-prd.md - AI feature requirements guide
  • references/writing-style-guide.md - How to write clear requirements
  • references/prioritization-management.md - Priority frameworks, change management, compliance
  • references/worked-example.md - End-to-end worked example (HelpBot customer support agent)

Summary: The PRD Writer's Mindset

┌─────────────────────────────────────────────────────────────────┐
│  1. ASSUME NOTHING - If not written, it doesn't exist.         │
│  2. BE SPECIFIC - Numbers, not adjectives.                     │
│  3. THINK NEGATIVELY - What can go wrong?                      │
│  4. SEEK CHALLENGES - Questions reveal gaps.                   │
│  5. ITERATE - PRDs are never done on first draft.              │
└─────────────────────────────────────────────────────────────────┘

The goal is to transfer understanding so completely that anyone can build exactly what you envision.

适合场景

01

用户想查找某类 Agent Skill 时

02

需要根据任务场景推荐可安装能力包时

03

需要对比不同来源的安装命令和来源信息时

能力概览

能力 1

按任务关键词查找相关 Skills

能力 2

展示可复制的安装命令

能力 3

保留来源站点、仓库和原始说明,方便继续核验

能力 4

展示第三方安全扫描或审计结果

安装后应在对应宿主中按原始 README 的触发条件使用;具体调用方式请以来源页面和 README 为准。

平台分布

Codex

37.19%
按下载量换算65

Claude

26.71%
按下载量换算46

Cursor

18.73%
按下载量换算33

Gemini CLI

8.41%
按下载量换算15

安全审计

Gen Agent Trust Hub

可疑

Socket

通过

Snyk

通过

权限和风险

敏感数据

该 Skill 可能接触密钥、Token、环境变量或敏感配置,应进入高风险复核队列,默认不自动发布。

安装前确认

本站仅展示第三方公开信息,不托管安装包,不提供自动安装或运行环境。安装前应自行审查源码、依赖和命令行为。来源安全扫描存在 warning/failed 结果,不能写成本站确认安全。当前只有一个来源,正式发布前建议补源仓库或其他目录站核验。

来源信息

继续浏览同类 Skills