Complete workflow for project documentation including ADRs, PRDs, personas, and docs organization. Use when setting up documentation for a new project or improving existing docs. Triggers on project documentation, ADR, PRD, personas, docs structure, documentation setup.
数据来源:ClawHub。 在 ClawSkills 查看
选择你使用的 Agent
方法一:命令行安装(推荐)
推荐(无需提前安装 clawhub)
npx clawhub@latest --dir ~/.claude/skills install project-documentation或使用 clawhub CLI(需提前安装)
clawhub --dir ~/.claude/skills install project-documentation⚠️ 需要 Node.js 18+,没有 Node?请使用下方方法二直接下载 ZIP。 安装 Node.js →
方法二:手动下载安装(无需 Node)
下载 ZIP,解压后将文件夹放到以下路径,重启 Agent 即可:
安装路径
~/.claude/skills/project-documentation/💡解压后将文件夹放到上方路径,重启 Agent 即可生效
--- name: project-documentation model: standard description: Complete workflow for project documentation including ADRs, PRDs, personas, and docs organization. Use when setting up documentation for a new project or improving existing docs. Triggers on project documentation, ADR, PRD, personas, docs structure, documentation setup. ---
Complete workflow for setting up and maintaining project documentation.
npx clawhub@latest install project-documentation
---
---
Start every project with documentation, not code:
1. Define the idea → What is this? What problem does it solve?
2. Define the personas → Who uses this? What are their journeys?
3. Define the features → What does it do for each persona?
4. Define the stack → What technologies? Why?
5. Then build → With full context established
---
docs/
├── architecture/ # CURRENT STATE - Living docs of actual code
│ ├── overview.md
│ └── data-flow.md
├── guides/ # CURRENT STATE - How to use/operate
│ ├── getting-started.md
│ └── configuration.md
├── runbooks/ # CURRENT STATE - Short, actionable guides
│ ├── local-dev.md
│ ├── deploy.md
│ └── database.md
├── planning/ # FUTURE - Not for docs site
│ ├── roadmap.md
│ └── specs/
├── decisions/ # ADRs - Decision records
│ ├── 001-tech-stack.md
│ └── 002-auth-approach.md
└── product/ # PRD, personas
├── overview.md
├── personas/
└── features.md
---
| Category | Purpose | Goes on Docs Site? | |----------|---------|-------------------| | Current State | How things work now | Yes | | Planning | Future specs, designs | No | | Architecture | Living docs of code | Yes | | Roadmap/Todos | What we're working on | No | | Runbooks | How to operate | Yes | | Proposed Runbooks | Future plans | No |
---
Template:
# ADR-001: [Title]
## Status
[Proposed | Accepted | Deprecated | Superseded]
## Context
[What is the issue we're solving?]
## Decision
[What did we decide?]
## Consequences
[What are the results - positive and negative?]
## Alternatives Considered
[What other options did we evaluate?]
Template:
# PRD: [Feature Name]
## Problem
[What problem are we solving?]
## Users
[Which personas does this serve?]
## Requirements
- [ ] Requirement 1
- [ ] Requirement 2
## Non-Goals
[What are we explicitly NOT doing?]
## Success Metrics
[How do we know this worked?]
Template:
# Persona: [Name]
## Who They Are
- Background
- Technical level
- Goals
## Pain Points
- [Pain 1]
- [Pain 2]
## Journey
1. Discovery
2. Onboarding
3. Daily use
4. Advanced usage
## Content Needs
- Doc types they need
- Format preferences
Template:
# Runbook: [Task Name]
## Prerequisites
- [Requirement 1]
- [Requirement 2]
## Steps
1. [Step 1]
2. [Step 2]
## Verify
[How to confirm success]
## Troubleshooting
| Problem | Solution |
|---------|----------|
| [Issue] | [Fix] |
---
## Roadmap
### Current Sprint
- [ ] Add user authentication endpoint
- [ ] Create login form component
- [ ] Wire form to auth endpoint
### Backlog
- [ ] Password reset flow
- [ ] OAuth integration
- [ ] Two-factor auth
---
Before shipping docs:
---
---
---
安装 Project Documentation 后,可以对 AI 说这些话来触发它
Help me get started with Project Documentation
Explains what Project Documentation does, walks through the setup, and runs a quick demo based on your current project
Use Project Documentation to complete workflow for project documentation including ADRs, PRDs, p...
Invokes Project Documentation with the right parameters and returns the result directly in the conversation
What can I do with Project Documentation in my product manager workflow?
Lists the top use cases for Project Documentation, with example commands for each scenario
将技能文件夹放到 ~/.claude/skills/project-documentation/ 目录(个人级,所有项目可用),或 .claude/skills/project-documentation/(项目级)。重启 AI 客户端后,用 /project-documentation 主动调用,或让 AI 根据上下文自动发现并使用。
Project Documentation 支持 Claude、Cursor、OpenClaw,可与这些 AI 平台无缝集成,扩展其能力。
Project Documentation 可免费安装使用。请查阅仓库了解许可证信息。
Complete workflow for project documentation including ADRs, PRDs, personas, and docs organization. Use when setting up documentation for a new project or improving existing docs. Triggers on project documentation, ADR, PRD, personas, docs structure, documentation setup.
Automate my product manager tasks using Project Documentation
Identifies repetitive steps in your workflow and sets up Project Documentation to handle them automatically
Project Documentation 属于「Product Manager」分类,该分类的技能帮助 AI 智能体在此领域执行专业任务。