Skip to content
cccskills
FreePublished on GitHub

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.

The English summary is being prepared. Showing the original description.

See how to install

Files included (2)

  • SKILL.md1.7 KB
  • agents/openai.yaml319 B

SKILL.md (original)

Review the instructions the agent will receive before you install.

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

RationalizationWhy It's WrongDo Instead
"Developers will figure it out"Novice users won'tWrite for the least experienced reader
"The code example speaks for itself"Examples without context confuseAdd what it does and when to use it
"Too much detail clutters the doc"Missing detail blocks usersInclude 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

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

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.

The English summary is being prepared. Showing the original description.

codeaholicguy/ai-devkit1.7KUpdated Oct 18, 2026

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.

The English summary is being prepared. Showing the original description.

codeaholicguy/ai-devkit1.7KUpdated Oct 18, 2026

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.

The English summary is being prepared. Showing the original description.

codeaholicguy/ai-devkit1.7KUpdated Oct 18, 2026

AI DevKit · Check local AI DevKit readiness and run setup only when status shows onboarding or harness integration gaps.

The English summary is being prepared. Showing the original description.

codeaholicguy/ai-devkit1.7KUpdated Oct 18, 2026

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.

The English summary is being prepared. Showing the original description.

codeaholicguy/ai-devkit1.7KUpdated Oct 18, 2026

AI DevKit · Update CHANGELOG.md Unreleased items from git commits since the latest release. Use when users ask to update changelog/release notes from recent commits, with one concise line per commit and commit/PR links.

The English summary is being prepared. Showing the original description.

codeaholicguy/ai-devkit1.7KUpdated Oct 18, 2026

See all skills by codeaholicguy

Report a problem with this skill