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.
Why use this skill?
Use the project-documentation skill to standardize your ADRs, PRDs, and project structures. Improve developer collaboration with a Docs-First workflow.
Install via CLI (Recommended)
clawhub install openclaw/skills/skills/wpank/project-documentationWhat This Skill Does
The project-documentation skill serves as a comprehensive framework for establishing, maintaining, and scaling documentation within any software project managed by OpenClaw. It enforces a 'Docs-First' philosophy by providing standardized templates for Architecture Decision Records (ADRs), Product Requirements Documents (PRDs), and persona definitions. Beyond mere templates, it provides a rigorous directory structure that forces a clean separation between 'Current State' documentation (which should be published) and 'Future Planning' artifacts (which remain internal). By standardizing how your team documents decisions and requirements, this skill reduces technical debt and ensures that new contributors have a clear, source-of-truth path to understanding the project history.
Installation
You can install the project-documentation skill directly through the OpenClaw/Moltbot/Clawbot CLI. Simply run the following command in your project root directory:
npx clawhub@latest install project-documentation
Use Cases
This skill is ideal for teams or solo developers who want to avoid the 'spaghetti documentation' trap. Use it when:
- Bootstrapping a brand new repository to set up a professional documentation directory structure.
- Converting scattered README files into a structured documentation site.
- Formalizing technical discussions by generating ADRs to ensure architectural transparency.
- Defining user personas to align the development team on who the software is actually serving.
- Cleaning up existing documentation by identifying which files belong in a public-facing site versus internal planning repositories.
Example Prompts
- "Initialize the project-documentation directory structure in this repository and generate a draft ADR for our switch to PostgreSQL."
- "I need to document our new API feature. Can you create a PRD using the project-documentation template, focusing on the persona of a backend developer?"
- "Analyze our current docs/ folder and suggest which files should be moved to /planning based on the current-vs-future separation rules."
Tips & Limitations
- Strict Separation: Always prioritize moving finished docs to the architecture/ or runbooks/ folders. If a document describes a feature that doesn't exist yet, it belongs in /planning.
- Living Docs: ADRs are only useful if they are updated. Treat the
decisions/folder as a chronological log of how the system reached its current state. - Persona Accuracy: Keep persona docs updated. If your user base changes, update the persona document to prevent building features for an outdated target audience.
- Limitations: This skill manages templates and structure; it does not automatically scan your codebase to verify that documentation is up-to-date with current code logic. Manual verification is still required.
Metadata
Not sure this is the right skill?
Describe what you want to build — we'll match you to the best skill from 16,000+ options.
Find the right skillPaste this into your clawhub.json to enable this plugin.
{
"plugins": {
"official-wpank-project-documentation": {
"enabled": true,
"auto_update": true
}
}
}Tags(AI)
Flags: file-write, file-read
Related Skills
mermaid-diagrams
Create software diagrams using Mermaid syntax. Use when users need to create, visualize, or document software through diagrams including class diagrams, sequence diagrams, flowcharts, ERDs, C4 architecture diagrams, state diagrams, git graphs, and other diagram types. Triggers include requests to diagram, visualize, model, map out, or show the flow of a system.
api-design-principles
Skill by wpank
auto-context
Automatically read relevant context before major actions. Loads TODO.md, roadmap.md, handoffs, task plans, and other project context files so the AI operates with full situational awareness. Use when starting a task, implementing a feature, refactoring, debugging, planning, or resuming a session.
clear-writing
Write clear, concise prose for humans — documentation, READMEs, API docs, commit messages, error messages, UI text, reports, and explanations. Combines Strunk's rules for clearer prose with technical documentation patterns, structure templates, and review checklists.
track-performance
Track the performance of Uniswap LP positions over time — check which positions need attention, are out of range, or have uncollected fees. Use when the user asks how their positions are doing.