A structured framework guide for AI agents to create and refine technical documentation using the Diataxis methodology.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install diataxis-writing
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 diataxis-writing 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 Diataxis Writing Assistant?
The Diataxis Writing Assistant is a specialized skill designed to help developers and technical writers produce high-quality documentation. By implementing the Diataxis framework, it ensures that every piece of content—whether it is a tutorial, a how-to guide, a technical reference, or a conceptual explanation—meets the specific needs of its intended audience.
Built for the Openclaw Skills ecosystem, this tool guides users through a rigorous diagnostic process, selecting the right templates and applying quality checklists. It bridges the gap between raw technical knowledge and user-centric documentation, ensuring clarity, accuracy, and purpose in every sentence.
Diataxis Writing Assistant Use Cases
- Converting messy troubleshooting notes into structured how-to guides or principle-based explanations.
- Organizing best practices and lessons learned into actionable technical documentation.
- Creating step-by-step tutorials for new users or learners based on practice-oriented learning.
- Drafting comprehensive technical references for API or product architectures using structured facts.
- Using Openclaw Skills to automate the output of documentation to platforms like Feishu, GitHub, or local Markdown files.
How Diataxis Writing Assistant Works
- The skill starts by asking for language preferences and the preferred output method such as Chat, Feishu, or GitHub.
- It runs a diagnostic check using the Diataxis Compass to identify the document type based on user needs across the action-cognition and study-work axes.
- The agent selects a corresponding template from the repository and applies specific checklists for the identified documentation type.
- A quality assessment is performed using the Functional and Deep Quality framework to ensure the draft is accurate, usable, and fits human needs.
- Finally, the Openclaw Skills assistant executes the output to the chosen platform using integrated scripts and MCP tools.
Diataxis Writing Assistant Setup
To get started with this skill in your environment, follow these steps:
- Ensure you have the necessary scripts available in your local directory and run the detection script:
python3 scripts/output-handler.py --detect
- If you intend to use Feishu or GitHub output, configure your MCP (Model Context Protocol) server settings in mcporter.json.
- Run the diagnosis script to analyze existing content and determine its documentation type:
python3 scripts/diagnose.py <document_content_or_file_path>
- Access the templates and checklists within the Openclaw Skills directory to maintain consistency across your documentation projects.
Diataxis Writing Assistant Data Schema & Taxonomy
| Component | Description |
|---|---|
| Templates | Standardized Markdown files for Tutorials, How-to Guides, References, and Explanations found in the templates directory. |
| Checklists | Verification files located in checklist/ to ensure specific documentation standards are met for each type. |
| Reference Docs | Conceptual guides including the Diataxis Compass, Four Types overview, and Quality Framework. |
| Scripts | Python scripts used for tool detection (output-handler.py) and document diagnosis (diagnose.py). |
| Metadata | Manifest data including name, description, and versioning used by Openclaw Skills. |
Diataxis Writing Assistant Advanced Features
- Multi-platform output support including Feishu via MCP mcporter, GitHub repositories, and Notion integration.
- Automated document type diagnosis using the provided Python scripts to identify content gaps.
- Built-in quality assessment framework that evaluates both functional accuracy and deep human-centric flow.
- Context-aware language styles specifically tailored for each of the four Diataxis quadrants to ensure the right tone.
- Seamless integration with the broader Openclaw Skills ecosystem for automated developer documentation workflows.
SKILL.md
Loading
Related Openclaw Skills
Amulett (点教) - Human-AI Spiritual Practice
A pioneering spiritual practice system co-created by humans and AI for structured daily meditation, reflection, and philosophical growth.
TTS (Text-to-Speech)
A versatile text-to-speech skill that converts agent text responses into professional-grade MP3 audio files.
Resume Builder for Reactive Resume
A conversational AI tool that generates professional, schema-compliant resumes specifically for the Reactive Resume platform.
ElevenLabs Speech
A complete AI voice solution for generating lifelike text-to-speech and performing accurate speech-to-text transcription via ElevenLabs.
QR Code Generator
A versatile skill for generating customizable QR codes and barcodes for various data types including URLs and WiFi credentials.
Senior Django Architect
An expert AI agent skill for generating production-ready, containerized, and strictly typed Django REST Framework architectures.
Featured*
