Beads Documentation Style Guide
gastownhall/beads
Sets the house style for the beads user docs: the canonical concept model, required terminology, prose and diagram conventions, and checks before docs work is done.
AI DevKit · Review and improve documentation for novice users.
Install Technical Writer
$ npx skills add codeaholicguy/ai-devkit --skill technical-writer -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install codeaholicguy/ai-devkit technical-writer --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/codeaholicguy/ai-devkit.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/technical-writer .claude/skills/technical-writer && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "technical-writer" agent skill from https://github.com/codeaholicguy/ai-devkit/tree/main/skills/technical-writer into .claude/skills/technical-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "technical-writer", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/codeaholicguy/ai-devkit/tree/main/skills/technical-writerType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add codeaholicguy/ai-devkit --skill technical-writer -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install codeaholicguy/ai-devkit technical-writer --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/codeaholicguy/ai-devkit.git skills-src && mkdir -p .agents/skills && cp -r skills-src/skills/technical-writer .agents/skills/technical-writer && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "technical-writer" agent skill from https://github.com/codeaholicguy/ai-devkit/tree/main/skills/technical-writer into .agents/skills/technical-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "technical-writer", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add codeaholicguy/ai-devkit --skill technical-writer -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install codeaholicguy/ai-devkit technical-writer --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/codeaholicguy/ai-devkit.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/skills/technical-writer .cursor/skills/technical-writer && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "technical-writer" agent skill from https://github.com/codeaholicguy/ai-devkit/tree/main/skills/technical-writer into .cursor/skills/technical-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "technical-writer", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/codeaholicguy/ai-devkit.git --path skills/technical-writer--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add codeaholicguy/ai-devkit --skill technical-writer -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install codeaholicguy/ai-devkit technical-writer --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/codeaholicguy/ai-devkit.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/skills/technical-writer .gemini/skills/technical-writer && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "technical-writer" agent skill from https://github.com/codeaholicguy/ai-devkit/tree/main/skills/technical-writer into .gemini/skills/technical-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "technical-writer", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install codeaholicguy/ai-devkit technical-writerInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add codeaholicguy/ai-devkit --skill technical-writer -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/codeaholicguy/ai-devkit.git skills-src && mkdir -p .github/skills && cp -r skills-src/skills/technical-writer .github/skills/technical-writer && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "technical-writer" agent skill from https://github.com/codeaholicguy/ai-devkit/tree/main/skills/technical-writer into .github/skills/technical-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "technical-writer", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add codeaholicguy/ai-devkit --skill technical-writer -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install codeaholicguy/ai-devkit technical-writer --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/codeaholicguy/ai-devkit.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/skills/technical-writer .opencode/skills/technical-writer && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "technical-writer" agent skill from https://github.com/codeaholicguy/ai-devkit/tree/main/skills/technical-writer into .opencode/skills/technical-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "technical-writer", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
technical-writer- GitHub stars
- 1.6k
- Token cost
- ~431 tokens
- SKILL.md length
- 149 words
- Files
- 2
- Skills in repo
- 28
- Repo updated
- First seen
- Licence
- Apache-2.0
At a glance
AI DevKit · Review and improve documentation for novice users.
- Users ask to review docs
- SKILL.md covers Hard Rules, Review Dimensions (rate 1-5), Priority and Red Flags and Rationalizations, plus 1 more section
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
- Improve documentation
What it does
Technical Writer is an agent skill from codeaholicguy/ai-devkit. 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.
Its SKILL.md is about 430 tokens, which your agent loads only when the skill is triggered. The skill folder holds 2 other files (for example `agents/openai.yaml`).
It sits in Writing & Content, covering Technical writing and Technical documentation. The repository describes itself as: The control plane for AI coding agents. The licence is Apache-2.0.
When your agent uses it
- Users ask to review docs
- Improve documentation
- Audit README files
- Evaluate API docs
Example prompts
- “/technical-writer”
What it can do on your machine
Read from SKILL.md and the folder at commit 7ef0cd5. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
No scripts in the folder and no shell commands in SKILL.md.
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Context cost
Technical Writer loads about 431 tokens when it runs. Until then it costs about 55 tokens; SKILL.md has 149 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.
SKILL.md
The full file from codeaholicguy/ai-devkit at commit 7ef0cd5, republished under its Apache-2.0 licence (© codeaholicguy). 149 words, ~431 tokens.
Download SKILL.mdSave it as
.claude/skills/technical-writer/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.- name
- technical-writer
- description
- 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.
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© codeaholicguy, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
SKILL.md and 1 other file in skills/technical-writer of codeaholicguy/ai-devkit.
- SKILL.md
- agents/openai.yaml
Open the folder on GitHubat commit 7ef0cd5
Compare with similar skills
Technical Writer next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Technical Writer this skillcodeaholicguy/ai-devkit | 1.6k | — | ~431 | Automated safety check: Pass | Apache-2.0 | |
| Beads Documentation Style Guidegastownhall/beads | 28k | — | ~3.2k | Automated safety check: Pass | MIT | |
| JavaScript Concept Page Workflowleonardomso/33-js-concepts | 67k | — | ~3.9k | Automated safety check: Pass | MIT | |
| Technical Writing Standardcursor/plugins | 10k | 10 repos | ~2.4k | Automated safety check: Pass | None | |
| Heym Documentation Articlesheymrun/heym | 1.4k | — | ~780 | Automated safety check: Pass | Custom licence | |
| JavaScript Concept Page Writerleonardomso/33-js-concepts | 67k | — | ~14k | Automated safety check: Pass | MIT |
Similar skills
JavaScript Concept Page Workflow
leonardomso/33-js-concepts
Orchestrates five skills to produce a complete JavaScript concept documentation page, from resource curation through writing, tests, fact-checking and SEO.
- Official
Technical Writing Standard
cursor/plugins
Applies four layers of technical-writing rules to docs, RFCs, readmes, PR descriptions and commit messages so a tired engineer follows them on the first read.
Heym Documentation Articles
heymrun/heym
Creates and updates documentation articles for the Heym platform: category choice, manifest entry, markdown file and cross-links from existing pages.
JavaScript Concept Page Writer
leonardomso/33-js-concepts
Writes or reviews documentation pages for the 33 JavaScript Concepts project, following its structure, a beginner-friendly voice and rules against AI-sounding language.
Technical Writing Workflow
tokenbender/agent-guides
A skill your agent uses for planning, researching, drafting, revising, or auditing technical write-ups, textbooks, papers, reports, READMEs, research notes, PR narratives, and public technical prose.
More from codeaholicguy/ai-devkit
All 28 skills in this repoAgent Management
codeaholicguy/ai-devkit
AI DevKit · Manage running AI agents with ai-devkit agent commands.
Dev Lifecycle
codeaholicguy/ai-devkit
AI DevKit · Orchestrator for structured SDLC phase skills. An agent skill from codeaholicguy/ai-devkit.
Task
codeaholicguy/ai-devkit
AI DevKit · Track dev-lifecycle / structured-debug progress on a durable task with the ai-devkit task CLI.
Simplify Implementation
codeaholicguy/ai-devkit
AI DevKit · Analyze and simplify existing implementations to reduce complexity, improve maintainability, and enhance scalability.
Agent Communication
codeaholicguy/ai-devkit
AI DevKit · Exchange information with active Codex, Claude Code, and other AI agents using ai-devkit agent list, detail, and send.
AI Devkit Setup
codeaholicguy/ai-devkit
AI DevKit · Check local AI DevKit readiness and run setup only when status shows onboarding or harness integration gaps.
Related
Categories
Questions about Technical Writer
What does Technical Writer do?
AI DevKit · Review and improve documentation for novice users. Technical Writer is an agent skill from codeaholicguy/ai-devkit. AI DevKit · Review and improve documentation for novice users.
When should I use Technical Writer?
Technical Writer fits situations like: users ask to review docs; improve documentation; audit README files; evaluate API docs.
How do I install Technical Writer in Claude Code?
Run `npx skills add codeaholicguy/ai-devkit --skill technical-writer -a claude-code`. Or copy the skill folder (skills/technical-writer in codeaholicguy/ai-devkit) into .claude/skills/technical-writer in your project. Claude Code loads it when a task matches its description.
How do I install Technical Writer in Codex?
Run `npx skills add codeaholicguy/ai-devkit --skill technical-writer -a codex`. Or copy the skill folder (skills/technical-writer in codeaholicguy/ai-devkit) into .agents/skills/technical-writer in your project. Codex loads it when a task matches its description.
Can I use Technical Writer in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add codeaholicguy/ai-devkit --skill technical-writer -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/technical-writer, .gemini/skills/technical-writer, .github/skills/technical-writer and .opencode/skills/technical-writer in your project.
What does Technical Writer need to run?
SKILL.md names no scripts, command-line tools or credentials: Technical Writer is instructions for the agent only.
Does Technical Writer access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is Technical Writer safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.
What licence does Technical Writer use?
Technical Writer is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Technical Writer use?
About 431 tokens (SKILL.md is roughly 1.7k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to Technical Writer?
Skills that share tags, products or a category with Technical Writer: Beads Documentation Style Guide (gastownhall/beads, 28k stars), JavaScript Concept Page Workflow (leonardomso/33-js-concepts, 67k stars), Technical Writing Standard (cursor/plugins, 10k stars) and Heym Documentation Articles (heymrun/heym, 1.4k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Technical Writer?
codeaholicguy (a GitHub user) maintains it in codeaholicguy/ai-devkit, which has 1,641 GitHub stars. The repository holds 28 skills in this directory. The repository was last updated on October 6, 2026.
Source: codeaholicguy/ai-devkit on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.