technical-writer
This Claude Code skill audits technical documentation through the lens of a novice user, rating clarity, completeness, actionability, and structure on five-point scales. Use it when reviewing README files, API documentation, guides, or other technical writing to identify blocking issues and receive concrete improvement suggestions before rewriting occurs.
git clone --depth 1 https://github.com/codeaholicguy/ai-devkit /tmp/technical-writer && cp -r /tmp/technical-writer/skills/technical-writer ~/.claude/skills/technical-writerSKILL.md
# Technical Writer Review Review documentation as a novice would experience it. Suggest concrete improvements. ## Hard Rules - Do not rewrite documentation until the user approves the suggested fixes. - Suggest concrete fix text, not vague advice. ## Review Dimensions (rate 1-5) - **Clarity**: Can a novice understand it without outside help? - **Completeness**: Are prerequisites, examples, and edge cases covered? - **Actionability**: Can users copy-paste commands and follow along? - **Structure**: Does it flow logically from simple to complex? ## Priority - **High**: Blocks novice users from succeeding. - **Medium**: Causes confusion but workaround exists. - **Low**: Polish and nice-to-have. ## Red Flags and Rationalizations | Rationalization | Why It's Wrong | Do Instead | |---|---|---| | "Developers will figure it out" | Novice users won't | Write for the least experienced reader | | "The code example speaks for itself" | Examples without context confuse | Add what it does and when to use it | | "Too much detail clutters the doc" | Missing detail blocks users | Include prerequisites and edge cases | ## Output Template ``` ## [Document Name] | Aspect | Rating | Notes | |--------|--------|-------| | Clarity | X/5 | ... | | Completeness | X/5 | ... | | Actionability | X/5 | ... | | Structure | X/5 | ... | **Issues:** 1. [High] Description (line X) 2. [Medium] Description (line X) **Suggested Fixes:** - Concrete fix with example text ```
AI DevKit · Exchange information with active Codex, Claude Code, and other AI agents using ai-devkit agent list, detail, and send. Use when an agent needs to find another active agent, read its recent context, send it information, or request information back.
AI DevKit · Manage running AI agents with ai-devkit agent commands. Use when an agent needs to identify itself, list agents, start workers, inspect agent detail, assign work, group agents, resume sessions, stop agents, or delegate work to other agents.
AI DevKit · Supervise multi-agent workflows over repeated passes: poll progress, unblock waiting agents, coordinate dependencies, relay outputs, resolve conflicts, and verify completion. Use only for ongoing multi-agent coordination, not one-off list/detail/send/start/kill actions.
AI DevKit · Use when the user asks to brainstorm, ideate, generate ideas, expand options, challenge ideas, pressure-test ideas, compare concepts, narrow choices, name something, plan content angles, explore strategy, evaluate product ideas, technical approaches, experiments, or decisions.
AI DevKit · Compare implementation with design and requirements docs to ensure alignment.
AI DevKit · Pre-push code review against design docs.
AI DevKit · Safe git commit workflow for AI coding agents. Use when the user asks to commit, prepare a commit, stage changes, create a PR-ready checkpoint, or finish work with a conventional commit while avoiding unrelated user changes.
AI DevKit · Design phase guidance for reviewing feature design against requirements. Use when the user wants to validate architecture, review design docs, resolve design trade-offs, or run dev-lifecycle phase 3.