{"id":"34b62330-ff46-433b-ae7e-3a83c21c0f1d","shortId":"BMhW2E","kind":"skill","title":"technical-writer","tagline":"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.","description":"# Technical Writer Review\n\nReview documentation as a novice would experience it. Suggest concrete improvements.\n\n## Hard Rules\n- Do not rewrite documentation until the user approves the suggested fixes.\n- Suggest concrete fix text, not vague advice.\n\n## Review Dimensions (rate 1-5)\n- **Clarity**: Can a novice understand it without outside help?\n- **Completeness**: Are prerequisites, examples, and edge cases covered?\n- **Actionability**: Can users copy-paste commands and follow along?\n- **Structure**: Does it flow logically from simple to complex?\n\n## Priority\n- **High**: Blocks novice users from succeeding.\n- **Medium**: Causes confusion but workaround exists.\n- **Low**: Polish and nice-to-have.\n\n## Red Flags and Rationalizations\n\n| Rationalization | Why It's Wrong | Do Instead |\n|---|---|---|\n| \"Developers will figure it out\" | Novice users won't | Write for the least experienced reader |\n| \"The code example speaks for itself\" | Examples without context confuse | Add what it does and when to use it |\n| \"Too much detail clutters the doc\" | Missing detail blocks users | Include prerequisites and edge cases |\n\n## Output Template\n\n```\n## [Document Name]\n\n| Aspect | Rating | Notes |\n|--------|--------|-------|\n| Clarity | X/5 | ... |\n| Completeness | X/5 | ... |\n| Actionability | X/5 | ... |\n| Structure | X/5 | ... |\n\n**Issues:**\n1. [High] Description (line X)\n2. [Medium] Description (line X)\n\n**Suggested Fixes:**\n- Concrete fix with example text\n```","tags":["technical","writer","devkit","codeaholicguy","agent-skills","ai-assisted-development","antigravity","claude-code","codex","cursor","development","engineering"],"capabilities":["skill","source-codeaholicguy","skill-technical-writer","topic-agent-skills","topic-ai-assisted-development","topic-antigravity","topic-claude-code","topic-codex","topic-cursor","topic-development","topic-engineering","topic-engineering-enablement","topic-engineering-experience","topic-prd"],"categories":["ai-devkit"],"synonyms":[],"warnings":[],"endpointUrl":"https://skills.sh/codeaholicguy/ai-devkit/technical-writer","protocol":"skill","transport":"skills-sh","auth":{"type":"none","details":{"cli":"npx skills add codeaholicguy/ai-devkit","source_repo":"https://github.com/codeaholicguy/ai-devkit","install_from":"skills.sh"}},"qualityScore":"0.700","qualityRationale":"deterministic score 0.70 from registry signals: · indexed on github topic:agent-skills · 1174 github stars · SKILL.md body (1,470 chars)","verified":false,"liveness":"unknown","lastLivenessCheck":null,"agentReviews":{"count":0,"score_avg":null,"cost_usd_avg":null,"success_rate":null,"latency_p50_ms":null,"narrative_summary":null,"summary_updated_at":null},"enrichmentModel":"deterministic:skill-github:v1","enrichmentVersion":1,"enrichedAt":"2026-05-03T00:52:57.421Z","embedding":null,"createdAt":"2026-04-18T21:55:33.327Z","updatedAt":"2026-05-03T00:52:57.421Z","lastSeenAt":"2026-05-03T00:52:57.421Z","tsv":"'-5':70 '1':69,203 '2':208 'action':88,198 'add':163 'advic':65 'along':97 'api':24 'approv':55 'ask':14 'aspect':191 'audit':20 'block':109,180 'case':86,186 'caus':115 'clariti':71,194 'clutter':175 'code':154 'command':94 'complet':80,196 'complex':106 'concret':44,60,215 'confus':116,162 'context':161 'copi':92 'copy-past':91 'cover':87 'descript':205,210 'detail':174,179 'develop':138 'dimens':67 'doc':17,25,177 'document':7,19,36,51,189 'edg':85,185 'evalu':23 'exampl':83,155,159,218 'exist':119 'experi':41 'experienc':151 'figur':140 'file':22 'fix':58,61,214,216 'flag':128 'flow':101 'follow':96 'guid':27 'hard':46 'help':79 'high':108,204 'improv':6,18,29,45 'includ':182 'instead':137 'issu':202 'least':150 'line':206,211 'logic':102 'low':120 'medium':114,209 'miss':178 'much':173 'name':190 'nice':124 'nice-to-hav':123 'note':193 'novic':9,39,74,110,143 'output':187 'outsid':78 'past':93 'polish':121 'prerequisit':82,183 'prioriti':107 'rate':68,192 'ration':130,131 'reader':152 'readm':21 'red':127 'review':4,16,26,34,35,66 'rewrit':50 'rule':47 'simpl':104 'skill' 'skill-technical-writer' 'source-codeaholicguy' 'speak':156 'structur':98,200 'succeed':113 'suggest':43,57,59,213 'technic':2,30,32 'technical-writ':1 'templat':188 'text':62,219 'topic-agent-skills' 'topic-ai-assisted-development' 'topic-antigravity' 'topic-claude-code' 'topic-codex' 'topic-cursor' 'topic-development' 'topic-engineering' 'topic-engineering-enablement' 'topic-engineering-experience' 'topic-prd' 'understand':75 'use':11,170 'user':10,13,54,90,111,144,181 'vagu':64 'without':77,160 'won':145 'workaround':118 'would':40 'write':31,147 'writer':3,33 'wrong':135 'x':207,212 'x/5':195,197,199,201","prices":[{"id":"68b3a176-46db-4d49-a7e3-7d3206c84887","listingId":"34b62330-ff46-433b-ae7e-3a83c21c0f1d","amountUsd":"0","unit":"free","nativeCurrency":null,"nativeAmount":null,"chain":null,"payTo":null,"paymentMethod":"skill-free","isPrimary":true,"details":{"org":"codeaholicguy","category":"ai-devkit","install_from":"skills.sh"},"createdAt":"2026-04-18T21:55:33.327Z"}],"sources":[{"listingId":"34b62330-ff46-433b-ae7e-3a83c21c0f1d","source":"github","sourceId":"codeaholicguy/ai-devkit/technical-writer","sourceUrl":"https://github.com/codeaholicguy/ai-devkit/tree/main/skills/technical-writer","isPrimary":false,"firstSeenAt":"2026-04-18T21:55:33.327Z","lastSeenAt":"2026-05-03T00:52:57.421Z"}],"details":{"listingId":"34b62330-ff46-433b-ae7e-3a83c21c0f1d","quickStartSnippet":null,"exampleRequest":null,"exampleResponse":null,"schema":null,"openapiUrl":null,"agentsTxtUrl":null,"citations":[],"useCases":[],"bestFor":[],"notFor":[],"kindDetails":{"org":"codeaholicguy","slug":"technical-writer","github":{"repo":"codeaholicguy/ai-devkit","stars":1174,"topics":["agent-skills","ai","ai-assisted-development","antigravity","claude-code","codex","cursor","development","engineering","engineering-enablement","engineering-experience","prd"],"license":null,"html_url":"https://github.com/codeaholicguy/ai-devkit","pushed_at":"2026-05-03T00:18:58Z","description":"A universal CLI toolkit for AI agent skills, enabling structured AI-assisted development across tools like Cursor, Claude Code, Codex, and more.","skill_md_sha":"4edea4c98a5e7ced49a98cd7d94f7ac0793ce3f4","skill_md_path":"skills/technical-writer/SKILL.md","default_branch":"main","skill_tree_url":"https://github.com/codeaholicguy/ai-devkit/tree/main/skills/technical-writer"},"layout":"multi","source":"github","category":"ai-devkit","frontmatter":{"name":"technical-writer","description":"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."},"skills_sh_url":"https://skills.sh/codeaholicguy/ai-devkit/technical-writer"},"updatedAt":"2026-05-03T00:52:57.421Z"}}