Technical Writing Expert
Writes API docs, READMEs, ADRs and developer guides using the Diataxis framework
- Repository
- RightNow-AI/openfang
- Stars
- 18,243
- Licence
- Apache-2.0
- Files
- 1 file
What it does
This skill gives an AI agent the working method of a senior technical writer. When you ask for developer documentation, the agent organizes it into tutorials, how-to guides, reference material and explanations, and follows set formats for READMEs, API reference entries, architecture decision records and changelogs. It also favors clear, second-person wording, complete code examples and diagrams such as Mermaid or PlantUML.
Great for
- Developers who need a README, API reference or ADR drafted quickly
- Teams that want consistent documentation structure and changelog formatting
- Students learning how good developer documentation is organized
Skip it if
- Marketing copy or general prose, since the guidance is specific to developer documentation
- Situations needing verified code examples: the skill tells the agent to write tested examples, but it does not run or check them itself
Try asking
- “Write a README for this project with install steps, a quick-start example and a contributing guide”
- “Draft an architecture decision record for our decision to move to PostgreSQL”
- “Turn this function's source code into an API reference entry with parameters, return values and errors”
- “Reorganize our docs into tutorials, how-to guides, reference and explanation sections”
Install in 3 steps
- 1
Download the skill
The ZIP contains the 1 original files, the Apache-2.0 licence and an attribution note.
technical-writer.zip - 2
Add it to your agent
Claude Code (all projects)
mkdir -p ~/.claude/skills && unzip technical-writer.zip -d ~/.claude/skills/Claude Code / Agent SDK (this project only)
mkdir -p .claude/skills && unzip technical-writer.zip -d .claude/skills/Claude apps (web/desktop): Settings → Capabilities → Skills → Upload skill, and choose the ZIP.
- 3
Ask for the task
No special command needed — the agent reads the skill's description and loads it when your request matches. Try one of the prompts above.
Get better results
- Provide the actual code, API signatures or existing docs so the agent can document real behavior rather than guessing.
- Ask for one documentation mode at a time, such as a tutorial or a reference page, since the skill warns against mixing them.
- Review generated code examples by running them yourself, because the agent cannot guarantee they work in your environment.
What's inside
- SKILL.md
Redistributed unmodified from RightNow-AI/openfang under the Apache-2.0 licence. The assessment was drafted with AI from the skill's files on 2026-10-29. Skills can instruct your agent to run code — read SKILL.md and any scripts before installing.