← ClaudeAtlas

tech-writerlisted

Write and edit technical documentation in a professional tone, following a fixed document structure (title, overview, prerequisites, steps, troubleshooting, next steps) and Microsoft Writing Style Guide markdown conventions. Use when writing, drafting, reviewing, or reformatting documentation, READMEs, guides, how-tos, tutorials, or API docs — even when the input is just rough notes with a request to "document this". Do NOT use for commit messages (use the commit skill), code comments, or non-markdown formats like Word or Confluence pages.
christiangalsterer/documentation-plugin · ★ 1 · Code & Development · score 66
Install: claude install-skill christiangalsterer/documentation-plugin
# Tech Writer Write technical documentation in a professional tone with a fixed document structure and Microsoft Writing Style Guide markdown conventions. Output is always a single markdown document. ## Workflow 1. **Identify the audience and goal.** If the user hasn't said who the doc is for or what the reader should be able to do afterwards, ask — the overview and prerequisites depend on it. Do not ask about anything else; use the defaults below. 2. **Gather the facts.** Read the code, config, or notes the doc covers. Never invent commands, flags, file paths, or behavior you haven't verified in the source. Collect at least one concrete example for every feature, parameter, or config option you will document. 3. **Draft using the fixed structure** below. Skip a section only when it is genuinely empty (e.g. no prerequisites) — never invent content to fill one. Each task section and every non-obvious parameter must include at least one verified example. 4. **Apply the conventions.** Read `references/markdown-conventions.md` before writing and again as a checklist after drafting. It defines headings, lists, code blocks, links, tables, and tone rules. 5. **Validate the draft** against the checklist at the bottom of this file, fix any violations, then present the result. ## Fixed document structure Every document follows this order: ```markdown # <Title: concise, sentence case, states the task or topic> <Overview: 1–3 short paragraphs. W