A comprehensive meta-skill for establishing a professional docs-first development workflow using standardized templates and directory structures.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install project-documentation
2. Manual Installation
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
3. Prompt Installation
Copy this prompt to OpenClaw to install it automatically.
Help me install project-documentation using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).
Prefer to download?
Get the raw skill files in a ZIP archive.
What is Project Documentation Meta-Skill?
The project-documentation skill implements a rigorous docs-first philosophy, ensuring that technical projects are defined by clarity and intent before the first line of code is written. By leveraging Openclaw Skills, this workflow helps developers define ideas, personas, features, and technical stacks in a structured environment. It bridges the gap between high-level product requirements and low-level architectural decisions, providing a single source of truth for both human collaborators and AI agents.
This skill is designed to prevent common documentation rot by enforcing a strict separation between the current state of a project and future planning. Whether you are bootstrapping a new repository or refactoring the knowledge base of an enterprise application, this skill provides the necessary scaffolding to maintain professional-grade documentation consistently across your entire portfolio.
Project Documentation Meta-Skill Use Cases
- Initializing a standardized docs directory structure for new software repositories.
- Standardizing the process of recording architectural choices using Architecture Decision Records (ADRs).
- Developing detailed user personas to ensure feature development aligns with actual user needs.
- Creating actionable runbooks for local development, deployment, and database operations.
- Maintaining a clear roadmap and backlog that separates future goals from the current codebase reality within Openclaw Skills environments.
How Project Documentation Meta-Skill Works
- Initialize the documentation hierarchy by defining the core problem and target personas.
- Scaffold the directory structure to separate architecture, guides, runbooks, decisions, and product planning.
- Populate templates for ADRs, PRDs, and personas to establish a technical and product baseline.
- Apply quality gates to ensure documentation remains actionable, updated, and correctly categorized.
- Integrate with development workflows to update runbooks and architecture docs as the code evolves.
Project Documentation Meta-Skill Setup
To add this capability to your agent, install it via the clawhub CLI:
npx clawhub@latest install project-documentation
Project Documentation Meta-Skill Data Schema & Taxonomy
The skill organizes documentation into a specific taxonomy to ensure clarity and discoverability within Openclaw Skills managed projects:
| Directory | Purpose | Docs Site? |
|---|---|---|
architecture/ |
Living documentation of the actual codebase | Yes |
guides/ |
Onboarding and configuration manuals | Yes |
runbooks/ |
Actionable operational procedures (deploy, db) | Yes |
planning/ |
Future-facing specifications and designs | No |
decisions/ |
History of Architecture Decision Records (ADRs) | Yes |
product/ |
PRDs, user personas, and feature definitions | Yes |
Project Documentation Meta-Skill Advanced Features
- Comprehensive ADR template system to document status, context, and consequences of technical decisions.
- Docs-First workflow integration that forces persona and feature definition before stack selection.
- Strict separation logic to prevent the anti-pattern of mixing future planning with current-state documentation.
- Multi-persona support to tailor documentation depth based on the technical level of the reader.
- Automated quality gate checklist for verifying documentation readiness before shipping features using Openclaw Skills.
SKILL.md
Loading
Related Openclaw Skills
Professional Communication
A specialized communication framework for technical teams to draft clear, actionable emails, messages, and meeting agendas.
Production Readiness
A meta-skill that orchestrates specialized agents to audit logging, security, performance, and deployment for guaranteed service stability.
PostgreSQL Job Queue
A production-ready job queue implementation leveraging PostgreSQL for priority scheduling, batch claiming, and detailed progress tracking without external message brokers.
Portfolio Report
A comprehensive tool for generating detailed Uniswap portfolio reports including PnL, fees, and multi-chain position analysis.
Prometheus Monitoring & Observability
A comprehensive framework for deploying production-grade Prometheus monitoring, alerting, and service discovery.
Quality Gates
An automated framework for enforcing technical standards and security protocols at every stage of the software development lifecycle.
Featured*
