Skip to content

drafael/coding-harness / skills/technical-writing

technical-writing

Verified

Write, revise, or review substantial technical documentation and design artifacts for a defined reader and task. Use for READMEs, guides, tutorials, how-to documentation, reference material, runbooks, RFCs, ADRs, technical specifications, and implementation plans. Use a design workflow first when future behavior or architecture needs exploration. Use unslop, when available, for small style-only edits. Do not use for code-only work, routine messages, release notes, PR descriptions, commit messages, or verbatim text.

FileKindSize
LICENSEother1.0 KB
README.mdmarkdown3.6 KB
SKILL.mdskill md6.4 KB
references/document-modes.mdmarkdown5.5 KB
references/format-guidance.mdmarkdown4.6 KB
references/review-checklist.mdmarkdown4.7 KB
references/sentence-and-procedure-style.mdmarkdown5.7 KB
# Technical-writing skill

Writes and reviews substantial technical documentation for a defined reader and task. It combines document structure, local fact verification, procedural clarity, and a final prose-quality pass without imposing mechanical style rules.

## Activation

Use for substantial work on:

- READMEs and documentation landing pages;
- tutorials, how-to guides, reference documentation, and runbooks;
- RFCs, ADRs, technical specifications, and implementation plans;
- structural or technical reviews of those documents.

When `brainstorm` is available, use it first while future behavior, architecture, or other consequential design decisions need exploration. Otherwise, use the host's design workflow and mark unresolved decisions explicitly.

Example requests:

- "Write a README for this service from the current code and configuration."
- "Review this runbook for unsafe assumptions and missing recovery steps."
- "Turn these design notes into an RFC for the authentication change."
- "Restructure this API guide around the tasks users perform."

For style-only editing of messages, release notes, PR descriptions, commit messages, and other prose, use `unslop` when it is available. This skill does not own code-only work, marketing copy, UI strings, or controlled verbatim text.

## Behavior

The skill:

1. identifies the reader, their goal, and their assumed knowledge;
2. chooses a primary Diátaxis mode for user documentation or the appropriate format for a design artifact;
3. protects commands, identifiers, quotations, measurements, and other technical material;
4. verifies material claims against local repository evidence;
5. drafts or reviews around the reader's goal and highest-impact problems;
6. applies `unslop` after substantial prose changes when that skill is available, with a self-contained fallback pass;
7. reports contradictions and unverified claims instead of guessing.

Diátaxis guides tutorials, how-to guides, reference documentation, and explanation without imposing a rigid file taxonomy. RFCs, specifications, ADRs, and plans keep their own decision-oriented formats. Sentence rules are also diagnostic: passive voice, longer sentences, and varied punctuation remain valid when they are the clearest accurate choice.

## Structure

- `SKILL.md`: compact, self-sufficient workflow and skill boundaries.
- `references/document-modes.md`: primary-mode selection and mixed-document guidance.
- `references/sentence-and-procedure-style.md`: reader-focused, procedural, and ambiguity guidance.
- `references/format-guidance.md`: expectations for supported document families.
- `references/review-checklist.md`: staged technical-document audit.

Supporting references are loaded only when needed. The core does not depend on a named model, provider, tool, command syntax, runtime, or agent harness.

## Sources and license

This local adaptation is inspired by [Cursor pstack `technical-writing`](https://github.com/cursor/plugins/blob/b047069f4f3a73e87dd1f11f7913386d25876b91/pstack/skills/technical-writing/SKILL.md), written by Lauren Tan and distributed under the MIT License.

Its source-grounded guidance also draws from:

- [Diátaxis](https://diataxis.fr/)
- [Google developer documentation style](https://developers.google.com/style)
- [ASD-STE100 Issue 9](https://www.asd-ste100.org/assets/files/ASD-STE100_ISSUE9.pdf)
- John R. Kohl, *The Global English Style Guide*, [SAS sample chapter](https://support.sas.com/publishing/pubcat/chaps/60751.pdf)

The local text summarizes transferable principles rather than reproducing external specifications or controlled dictionaries. See `LICENSE` for the retained upstream MIT notice.
brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation).Stars: 322kUpdated Claude CodeCodexVerifiedInstall
brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply.Stars: 197kUpdated Claude CodeCodexVerifiedInstall
frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults.Stars: 197kUpdated Claude CodeCodexVerifiedInstall
mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK).Stars: 197kUpdated Claude CodeCodexVerifiedInstall