Agent skill · Security

technical-writer

AI DevKit · Review and improve documentation for novice users. Use when users ask to review docs, improve documentation, audit README files, evaluate API docs, review guides, or improve technical writing.

Hoang Nguyen1,568★ · +5/wk · 1 repos on radarProfile →
claude-codecodexcursor
Install
npx skills add codeaholicguy/ai-devkit --skill technical-writer --agent claude-code

Same command for any agent — swap --agent for codex, cursor, copilot.

Facts
Files in the skill folder: 2
SKILL.md size: 2 KB
Bundled scripts: none
Path: skills/technical-writer/SKILL.md
Open the folder on GitHub →
Where it comes from
Stars: 1,572 · +4 this week
Language: TypeScript
Read our review of the source →

Weekly change comes from our own snapshots, not the repository page — it measures attention, not adoption.

From the SKILL.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 | |--------|-

What's inside
Steps it walks through
  1. Hard Rules
  2. Review Dimensions (rate 1-5)
  3. Priority
  4. Red Flags and Rationalizations
  5. Output Template
Ships with 1 file
  • agents/openai.yaml
More from ai-devkit
All skills →
About this skill
What does the technical-writer skill do?

AI DevKit · Review and improve documentation for novice users. Use when users ask to review docs, improve documentation, audit README files, evaluate API docs, review guides, or improve technical writing.

How do I install it?

Run `npx skills add codeaholicguy/ai-devkit --skill technical-writer --agent claude-code` — it drops the skill into your project so the agent can pick it up. Swap the --agent value for codex, cursor or copilot if you use one of those.

Where does this skill come from?

From codeaholicguy/ai-devkit, a repository with 1,572 stars. We read it straight from the repository tree rather than a submitted listing, so what you see here is what is actually published.

Is a popular skill a good skill?

Not necessarily. Stars measure attention, not adoption — a repository can trend for a week and be abandoned. That is why we show the weekly change from our own snapshots next to the total, instead of a single flattering number.

Keep going