Technical Writer
Asks Claude to review your docs from a novice user's perspective and rate them across four dimensions: clarity, completeness, actionability, and structure. It won't rewrite anything until you approve, which is smart because you want to maintain your voice. The skill includes a table of common doc writing rationalizations like "developers will figure it out" and explains why they're wrong. Works well when you need someone to tell you your README assumes too much context or your API docs are missing the prerequisites that seem obvious to you. The priority system helps you focus on what actually blocks users versus what's just polish.
- GitHub stars
- 1.3K
- last updated
- Jun 11, 2026
Install
$ npx -y skills add codeaholicguy/ai-devkit --skill technical-writer --agent claude-codeInstalls into .claude/skills of the current project.
Files
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]
Sponsors
Promote your product hereReach 125k+ visitors monthlyPromote your product hereReach 125k+ visitors monthly
Agent CaffeineSponsoredClose your lid, come back to finished work
SnugSponsoredThe clipboard manager for the AI eraPromote your product hereReach 125k+ visitors monthly
WaxSponsoredBlock anything with supervision, without erasing your iPhonePromote your product hereReach 125k+ visitors monthly
knobsSponsoredSee your site on any phone, any day, in any language
Agent CaffeineSponsoredClose your lid, come back to finished workSnugSponsoredThe clipboard manager for the AI eraPromote your product hereReach 125k+ visitors monthlyWaxSponsoredBlock anything with supervision, without erasing your iPhonePromote your product hereReach 125k+ visitors monthlyknobsSponsoredSee your site on any phone, any day, in any languageDetails
- Repository
- github.com/codeaholicguy/ai-devkit
- Categories
- Backend & APIs, Git & Pull Requests, Documentation, Code Review & Quality, AI & Agent Building
- First seen
- Jun 11, 2026
More from codeaholicguy/ai-devkit
All 12Recommended
More Backend & APIs1
Knowledge Graph Builderdaffy0208/ai-dev-standardsDesign and build knowledge graphs. Use when modeling complex relationships, building semantic search, or creating knowledge bases. Covers schema design, entity 0skills.sh installs
Knowledge Graph Builderdaffy0208/ai-dev-standardsDesign and build knowledge graphs. Use when modeling complex relationships, building semantic search, or creating knowledge bases. Covers schema design, entity 0skills.sh installs2
AWS Penetration Testingdavila7/claude-code-templatesThis skill should be used when the user asks to "pentest AWS", "test AWS security", "enumerate IAM", "exploit cloud infrastructure", "AWS privilege escalation",0skills.sh installs
AWS Penetration Testingdavila7/claude-code-templatesThis skill should be used when the user asks to "pentest AWS", "test AWS security", "enumerate IAM", "exploit cloud infrastructure", "AWS privilege escalation",0skills.sh installs3Burp Suite Web Application Testingdavila7/claude-code-templatesThis skill should be used when the user asks to "intercept HTTP traffic", "modify web requests", "use Burp Suite for testing", "perform web vulnerability scanni0skills.sh installs
Burp Suite Web Application Testingdavila7/claude-code-templatesThis skill should be used when the user asks to "intercept HTTP traffic", "modify web requests", "use Burp Suite for testing", "perform web vulnerability scanni0skills.sh installs4Hook Developmentdavila7/claude-code-templatesThis skill should be used when the user asks to "create a hook", "add a PreToolUse/PostToolUse/Stop hook", "validate tool use", "implement prompt-based hooks", 0skills.sh installs
Hook Developmentdavila7/claude-code-templatesThis skill should be used when the user asks to "create a hook", "add a PreToolUse/PostToolUse/Stop hook", "validate tool use", "implement prompt-based hooks", 0skills.sh installs5Network 101davila7/claude-code-templatesThis skill should be used when the user asks to "set up a web server", "configure HTTP or HTTPS", "perform SNMP enumeration", "configure SMB shares", "test netw0skills.sh installs
Network 101davila7/claude-code-templatesThis skill should be used when the user asks to "set up a web server", "configure HTTP or HTTPS", "perform SNMP enumeration", "configure SMB shares", "test netw0skills.sh installs6Shodan Reconnaissance and Pentestingdavila7/claude-code-templatesThis skill should be used when the user asks to "search for exposed devices on the internet," "perform Shodan reconnaissance," "find vulnerable services using S0skills.sh installs
Shodan Reconnaissance and Pentestingdavila7/claude-code-templatesThis skill should be used when the user asks to "search for exposed devices on the internet," "perform Shodan reconnaissance," "find vulnerable services using S0skills.sh installs