Technical WriterAI technical writer
Creates clear documentation, READMEs, guides, and runbooks.
What This Skill Does
Documentation that people actually read. This skill writes clear, structured technical documentation: READMEs, getting-started guides, API references, runbooks, architecture decision records (ADRs), and changelogs. It follows the Diátaxis framework (tutorials, how-to guides, explanation, reference) and adapts writing style to the audience — from beginner-friendly tutorials to expert-level reference docs.
Who Should Use This
- Developers who hate writing docs
- Open-source maintainers
- Developer advocates
- Engineering teams with documentation debt
Common Use Cases
- Write READMEs with proper structure
- Create getting-started guides and tutorials
- Generate API reference documentation
- Write runbooks for operational procedures
- Create Architecture Decision Records (ADRs)
- Write changelogs and release notes
How It Works on OpenClaw
- 1
Install the skill
Browse the marketplace, pick a skill, and add it to your assistant with one click.
- 2
Pick your channel
Connect through Telegram, Discord, or WhatsApp — whichever you already use.
- 3
Start messaging
Send a message and your assistant responds with the skill's expertise, 24/7.
Best Channels and Models
Best Channels
Best Models
Limitations
- Cannot access your codebase directly — paste relevant code
- Generated docs should be reviewed for technical accuracy
- Cannot run code to verify examples
Not Suitable For
- Teams needing auto-generated docs from CI/CD pipeline integration
- Organizations requiring documentation with built-in versioning and publishing workflows
- Projects that need the AI to maintain docs in sync with every code change automatically
Example Interaction
You
I need a README for my open-source CLI tool that converts CSV files to JSON. It's written in Go.
Technical Writer
Here's your README: badges section (Go version, license, build status), one-liner description, installation (go install and Homebrew), quickstart with 3 common usage examples, flags reference table, configuration file docs, contributing guide section, and license. I followed the 'README first, docs later' principle — everything a new user needs in one file.
You
Write an ADR for our decision to switch from REST to GraphQL for our mobile app's API.
Technical Writer
ADR-007: Switch Mobile API from REST to GraphQL. Status: Accepted. Context: Mobile app makes 6-8 REST calls per screen, causing waterfall loading and over-fetching. Decision: Adopt GraphQL for mobile-facing endpoints, keep REST for server-to-server. Consequences: faster mobile load times, but team needs GraphQL training and we'll need to monitor query complexity. Alternatives considered: BFF pattern (rejected — too much infra overhead for our team size).
Setup Requirements
- OpenClaw account
- Discord or Telegram
- Your code, project description, or the technical decision you want documented
Frequently Asked Questions
What documentation framework does it follow?
The Diátaxis framework — organizing docs into tutorials (learning), how-to guides (problem-solving), explanation (understanding), and reference (information). It adapts based on what you need.
Can it generate docs from code?
Paste your code, types, or endpoint definitions and it generates clean documentation. For full codebases, share sections incrementally.
What format does it output?
Markdown by default, compatible with GitHub, Mintlify, ReadMe, GitBook, Docusaurus, and Notion. Can adapt to other formats on request.
Related Skills
Ready to try Technical Writer?
Install this skill and start using it on Telegram, Discord, or WhatsApp in under a minute.