Techwrite is a professional-grade documentation engine that transforms complex technical concepts into actionable, high-precision prose for developers and stakeholders.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install techwrite
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 techwrite 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 Techwrite: Deep Technical Writing Workflow?
Techwrite is a specialized workflow designed for AI agents to produce superior technical documentation. It shifts the focus from simple word count to clarity, correctness, and appropriate depth. By utilizing this Openclaw Skills asset, developers can ensure their documentation is scannable, honest, and tailored to specific reader personas, whether they are drafting internal RFCs, public API references, or complex migration guides.
This skill enforces a rigorous six-stage lifecycle that prevents common documentation pitfalls like ambiguous pronouns and hidden assumptions. It prioritizes the job-to-be-done, ensuring that every piece of content leads to a concrete success outcome where the reader can confidently act or decide without confusion.
Techwrite: Deep Technical Writing Workflow Use Cases
- Drafting comprehensive API references and integration guides for new features.
- Creating high-stakes engineering documents like RFCs (Request for Comments) and ADRs (Architecture Decision Records).
- Writing scannable runbooks, postmortems, and developer onboarding documentation.
- Refining existing technical pages to improve clarity and remove technical debt in prose.
- Generating troubleshooting tables and edge-case documentation to reduce support tickets.
How Techwrite: Deep Technical Writing Workflow Works
- Audience & Goal Definition: The skill starts by identifying a single primary reader persona and a specific job-to-be-done to ensure the content is focused.
- Outline & Scoping: It structures the document using the BLUF (Bottom Line Up Front) principle and maps sections to the reader's mental model.
- Core Content Drafting: Generates precise, active-voice prose while avoiding vague adjectives and defining technical terms on first use.
- Examples & Edge Cases: Integrates minimal complete code snippets and realistic failure scenarios to build user trust.
- Clarity Review: Performs a surgical edit to remove ambiguous pronouns and ensure all diagrams and links are functional and accessible.
- Maintenance Planning: Establishes ownership and review cadences to prevent documentation decay over time.
Techwrite: Deep Technical Writing Workflow Setup
To integrate Techwrite into your environment, ensure you have the Openclaw Skills runner installed and then add the techwrite definition to your agent's library:
# Add the techwrite skill to your local repository
openclaw skills add techwrite
# Trigger the workflow within your AI IDE or CLI
/skill techwrite "Draft an API guide for our new auth module"
Techwrite: Deep Technical Writing Workflow Data Schema & Taxonomy
Techwrite organizes documentation data into a structured taxonomy to maintain consistency across large doc sets:
| Attribute | Description | Format |
|---|---|---|
| Success Sentence | The explicit outcome for the reader | String |
| Persona | Targeted reader (e.g., SRE, New Hire) | Taxonomy Key |
| BLUF | Bottom Line Up Front summary | Markdown Block |
| Procedural Steps | Numbered sequence of actions | Ordered List |
| Metadata | Versioning, Owner, and Last Reviewed date | YAML Frontmatter |
Techwrite: Deep Technical Writing Workflow Advanced Features
- Multi-stage iteration support: Seamlessly move from rough outlines to polished, ship-ready prose.
- Template Integration: Ability to ingest and follow organizational style guides or specific document templates.
- Surgical Editing: Refines existing drafts while preserving the original author's voice.
- Accessibility Guardrails: Automated checks for alt-text in diagrams and stable URL structures.
- Strategic Deprecation: Guidance on handling redirects and page history for evolving platforms.
SKILL.md
Loading
Related Openclaw Skills
Serverless Deep Workflow
A comprehensive six-stage framework for designing, debugging, and scaling resilient serverless workloads across AWS Lambda, Azure Functions, and Google Cloud Functions.
Flight Itinerary OCR
A specialized OCR tool designed to extract structured passenger and flight data from airline transport electronic ticket itineraries.
Risk Assessment Skill
A professional framework for deep risk assessment, transforming project uncertainties into prioritized mitigation actions and accountable ownership.
Retro AI Postmortem Workflow
A comprehensive blameless postmortem framework designed to transform system failures into actionable reliability improvements.
Content Repurposer
The Content Repurposer transforms long-form articles, blogs, and transcripts into punchy, platform-optimized social media posts for LinkedIn, Twitter, and Instagram.
Minijuegos LeChuck SDK Integration
A comprehensive integration guide for the Minijuegos.com LeChuck JS SDK to handle player authentication, achievements, and persistent game statistics.
Featured*
