A comprehensive framework for creating enterprise-grade technical documentation using Diataxis and industry-standard style guides.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install developer-docs-framework
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 developer-docs-framework 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 Tech Docs Framework (Diataxis)?
This skill implements a unified system for technical writing, synthesizing proven frameworks like Diataxis, Google OpenDocs, and the Good Docs Project. It provides AI agents with the precise logic needed to distinguish between tutorials, how-to guides, reference material, and explanations. By leveraging these Openclaw Skills, development teams can ensure their documentation is task-oriented, architecturally sound, and optimized for developer adoption. It moves beyond generic writing advice to provide 27 specific rules covering everything from active voice to complex information architecture and documentation-as-code workflows.
Tech Docs Framework (Diataxis) Use Cases
- Writing clear, learning-oriented tutorials for onboarding new developers.
- Creating task-focused how-to guides for experienced practitioners.
- Auditing existing documentation to identify content gaps, overlaps, and misclassifications.
- Standardizing writing styles across a team using Google, Stripe, or Microsoft conventions.
- Designing a documentation strategy that aligns with the developer adoption funnel (Discover, Evaluate, Start, Build, Operate, Upgrade).
How Tech Docs Framework (Diataxis) Works
- The skill triggers upon identifying documentation-related tasks such as writing API docs, tutorials, or changelogs.
- It analyzes the specific user need against the Diataxis quadrants (Practical vs. Theoretical, Acquisition vs. Application).
- It selects the appropriate content type from 14 enterprise patterns, ensuring a single purpose per document.
- The system applies a hierarchy of rules starting with Content Architecture and Writing Style to ensure technical accuracy and readability.
- It utilizes pluggable style guides to match the output to specific organizational voices, such as Google or Stripe.
- Finally, it validates the structure against the Documentation Compass to ensure the content meets functional and deep quality standards.
Tech Docs Framework (Diataxis) Setup
To integrate this framework into your workflow, ensure your environment can access the rules and references provided in the Openclaw Skills repository.
# Standard setup involves referencing the skill in your agent configuration
# No complex CLI installation is required beyond providing the rule files
# Navigate to your skills directory and verify files:
ls -R rules/ references/
Tech Docs Framework (Diataxis) Data Schema & Taxonomy
The skill organizes documentation logic into a structured taxonomy for easy retrieval and application:
| Component | Type | Description |
|---|---|---|
| Rules | Markdown Files | 27 distinct rules prefixed by category (e.g., write-, style-, arch-). |
| References | Markdown Guides | Deep dives into content types, templates, and enterprise patterns. |
| Templates | Markdown Skeletons | Ready-to-use structures for tutorials, API references, and migration guides. |
| Styles | Override Profiles | Configuration files for Google, Microsoft, Stripe, and Canonical writing styles. |
Tech Docs Framework (Diataxis) Advanced Features
- Multi-framework synthesis combining Diataxis content architecture with Google OpenDocs maturity models.
- Pluggable writing styles allowing for seamless switching between brand voices like Stripe or Canonical.
- Developer Experience (DX) strategy integration via audience matrix mapping and time-to-hello-world optimization.
- Automated documentation audit rules for identifying technical debt and misclassified content quadrants.
- Docs-as-code workflow support, facilitating versioning and governance for enterprise documentation lifecycles.
SKILL.md
Loading
Related Openclaw Skills
X Trends Scraper
A CLI-based tool for scraping real-time X (Twitter) trending topics globally without requiring user authentication.
X Trends Scraper
A CLI-based scraper that retrieves real-time X (Twitter) trending topics and tweet volumes across multiple countries without requiring an API key or account.
Web Search Hub
A comprehensive CLI search utility that empowers AI agents to retrieve web pages, news, images, and videos via the DuckDuckGo API.
QR Code Generator
A versatile CLI tool for generating high-quality, customizable QR codes for diverse data types in multiple formats.
Jest Testing Specialist
A comprehensive guide and rule set for mastering Jest 29+ testing best practices in JavaScript and TypeScript projects.
MSW (Mock Service Worker) v2
A comprehensive guide and rule set for implementing Mock Service Worker v2 best practices in JavaScript and TypeScript projects.
Featured*
