Technical Writing
rsmdt/the-startup
Create architectural decision records (ADRs), system documentation, API documentation, and operational runbooks.
Writes, repairs and copyedits project docs against the Google developer documentation style guide, verifying claims in the repository before stating them.
$ npx skills add bgauryy/octocode --skill octocode-documentation -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install bgauryy/octocode octocode-documentation --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/bgauryy/octocode.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/octocode-documentation .claude/skills/octocode-documentation && 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 "octocode-documentation" agent skill from https://github.com/bgauryy/octocode/tree/main/skills/octocode-documentation into .claude/skills/octocode-documentation/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "octocode-documentation", 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/bgauryy/octocode/tree/main/skills/octocode-documentationType 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 bgauryy/octocode --skill octocode-documentation -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install bgauryy/octocode octocode-documentation --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/bgauryy/octocode.git skills-src && mkdir -p .agents/skills && cp -r skills-src/skills/octocode-documentation .agents/skills/octocode-documentation && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "octocode-documentation" agent skill from https://github.com/bgauryy/octocode/tree/main/skills/octocode-documentation into .agents/skills/octocode-documentation/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "octocode-documentation", 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 bgauryy/octocode --skill octocode-documentation -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install bgauryy/octocode octocode-documentation --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/bgauryy/octocode.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/skills/octocode-documentation .cursor/skills/octocode-documentation && 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 "octocode-documentation" agent skill from https://github.com/bgauryy/octocode/tree/main/skills/octocode-documentation into .cursor/skills/octocode-documentation/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "octocode-documentation", 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/bgauryy/octocode.git --path skills/octocode-documentation--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 bgauryy/octocode --skill octocode-documentation -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install bgauryy/octocode octocode-documentation --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/bgauryy/octocode.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/skills/octocode-documentation .gemini/skills/octocode-documentation && 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 "octocode-documentation" agent skill from https://github.com/bgauryy/octocode/tree/main/skills/octocode-documentation into .gemini/skills/octocode-documentation/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "octocode-documentation", 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 bgauryy/octocode octocode-documentationInstalls 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 bgauryy/octocode --skill octocode-documentation -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/bgauryy/octocode.git skills-src && mkdir -p .github/skills && cp -r skills-src/skills/octocode-documentation .github/skills/octocode-documentation && 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 "octocode-documentation" agent skill from https://github.com/bgauryy/octocode/tree/main/skills/octocode-documentation into .github/skills/octocode-documentation/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "octocode-documentation", 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 bgauryy/octocode --skill octocode-documentation -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install bgauryy/octocode octocode-documentation --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/bgauryy/octocode.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/skills/octocode-documentation .opencode/skills/octocode-documentation && 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 "octocode-documentation" agent skill from https://github.com/bgauryy/octocode/tree/main/skills/octocode-documentation into .opencode/skills/octocode-documentation/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "octocode-documentation", 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.
octocode-documentationWrites, repairs and copyedits project docs against the Google developer documentation style guide, verifying claims in the repository before stating them.
This skill covers missing, stale, wrong or badly written documentation: READMEs, API references, runbooks, CONTRIBUTING files, changelogs, onboarding guides, AGENTS.md and CLAUDE.md, ADRs, migration guides, docstrings, alt text and prose linting. It follows the flow understand, research, classify, outline gate, write, style and verify. A copyedit request starts at the style step, and a question about a single term is answered straight from a bundled Google word list.
Several rules keep the output honest. Claims are checked in the repository before they are written, and anything unverifiable is omitted or marked as not verified. Creating or overwriting files needs your approval of the targets, and only named files are touched. Each page follows one Diátaxis type, AGENTS.md stays an index of links, and durable pointers such as module paths are preferred over line numbers. An existing project style guide wins over the Google defaults, and conflicts are reported.
It is not meant for writing code, commit messages or marketing copy. Questions that need code investigation are handed to the octocode-research skill, and work on SKILL.md folders goes to octocode-skills.
Read from SKILL.md and the folder at commit c265e3f. It shows what the files ask for, not the result of running them.
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.
Ships 1 file in scripts/, which the agent can run.
From the folder's file list and the shell code blocks in SKILL.md.
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Evidence-Backed Documentation Writer loads about 2k tokens when it runs, and up to ~26k if it reads all its reference files. Until then it costs about 110 tokens; SKILL.md has 896 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.
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); the scripts in this folder are not scanned.
The full file from bgauryy/octocode at commit c265e3f, republished under its MIT licence (© bgauryy). 896 words, ~2,023 tokens.
.claude/skills/octocode-documentation/SKILL.md (or your agent's skills folder). This skill also uses 36 other files; get the full folder from GitHub.Evidence-backed docs for humans and agents, written to the Google developer documentation style guide. Classify first. Gate writes. Prefer durable cross-refs over code dumps.
UNDERSTAND → RESEARCH → CLASSIFY → OUTLINE GATE → WRITE → STYLE → VERIFY
UNDERSTAND names the deliverable, audience, and target paths. Compress when the request already names targets and type. Expand when claims need verification. A copyedit request starts at STYLE. Answer a single-term question ("is allows you to okay?") straight from assets/google-word-list.tsv — quote the guidance and stop.
references/style-index.md to every line you write or edit, and name the rule when you change someone else's wording.AGENTS.md is an index of links and non-obvious rules, not a content dump.Stop when: outline gate awaits answer; write+style+verify finishes; a word-list lookup answered the question; a missing fact makes the doc dishonest to write (otherwise mark "Not verified in repository" and continue); conventions conflict; user cancels.
| Mode | Deliverable | Route order |
|---|---|---|
| agent-docs | AGENTS.md, nested agent instructions, CLAUDE.md symlink | modes.md → evidence-research.md → agents-md.md → agent-readable.md → write-verify.md → style-lint.mjs |
| human-docs | README, tutorial, how-to, reference, explanation, runbook | modes.md → evidence-research.md → diataxis.md → agent-readable.md → write-verify.md → style-lint.mjs |
| adr | Architecture decision record | modes.md → evidence-research.md → adr.md → write-verify.md → style-lint.mjs |
| codebase-pack | Multi-file docs set | modes.md → plan the file set → gate once → per file: diataxis.md → write-verify.md → style-lint.mjs |
| style-pass | Edited text, or a style review report | style-index.md → the owning style-*.md → style-lint.mjs → style-review.md for a report someone else acts on |
| Phase | When | Read |
|---|---|---|
| CLASSIFY | Choosing mode or audience | references/modes.md |
| RESEARCH | Gathering or verifying repository facts | references/evidence-research.md |
| CLASSIFY | Choosing the Diátaxis type for human-docs, or reviewing one | references/diataxis.md |
| WRITE | Writing or updating agent instruction files | references/agents-md.md |
| WRITE | Recording a decision | references/adr.md |
| WRITE | Cross-refs, density, durability — read before the first line | references/agent-readable.md |
| OUTLINE GATE, WRITE, VERIFY | Outline gate, write steps, style pass, verify checklist | references/write-verify.md |
| STYLE | Any wording, formatting, or terminology question — maps every guide topic to its owner | references/style-index.md |
references/style-index.md owns the per-topic map| Ask | Read |
|---|---|
| Which reference owns this topic — every guide topic, one row each | references/style-index.md |
| Prose: tone, person, voice, tense, grammar, one specific word, abbreviations, jargon, translation, inclusive terms | references/style-voice.md, references/style-grammar.md, references/style-words.md, references/style-abbreviations.md, references/style-global.md, references/style-inclusive.md |
| Page shape: headings, lists, numbered steps, notices, tables, footnotes, figures, alt text | references/style-structure.md, references/style-procedures.md, references/style-blocks.md, references/style-images.md |
| Mechanics: bold/italic/code choice, capitalization, filenames, markup, punctuation, numbers, dates, units | references/style-format.md, references/style-punctuation.md, references/style-numbers.md |
| Technical text: code font, samples, command syntax, placeholders, example values, UI wording, link text | references/style-code.md, references/style-cli.md, references/style-examples.md, references/style-ui.md, references/style-links.md |
| Claims and reference text: time words, superlatives, product names, trademarks, third-party text, docstrings | references/style-claims.md, references/style-api.md |
| Producing a review someone else acts on, or checking a rule against the live guide | references/style-review.md, references/style-sources.md |
| Run | When | How it behaves |
|---|---|---|
scripts/style-lint.mjs <paths> | At STYLE, before hand-reading prose | Markdown only. ERROR gates, WARN is mechanical, INFO needs judgment. One finding per rule per line; --max-per-rule caps per file (default 20); --only/--skip select rules; --json for machine output. Exit 1 on ERROR, or on WARN with --strict; 2 on bad usage |
scripts/style-lint.mjs --self-test | After editing any rule | Lints built-in good/bad fixtures so a gate cannot go inert |
scripts/refresh-word-list.mjs --dry-run | When the word list looks stale | Rebuilds assets/google-word-list.tsv from developers.google.com; it fetches even with --dry-run, and refuses to write a short parse |
assets/google-word-list.tsv | Answering a single-term question | 597 guide entries with verdict and guidance; quote it and stop |
assets/google-style-pages.tsv | Finding which reference owns a guide page, or its URL | All 69 pages as slug, title, owner, url; grep -P "^tables\t" answers ownership, and the URL is what you fetch to verify |
Suppression: <!-- style-lint: ignore-file --> skips a file found by recursion, <!-- style-lint: ignore-line rule-id --> mutes named rules on one line. Both are inert inside a code span, so a page can document them. Docstrings, HTML, and UI strings stay hand-checked.
octocode-research; authoring a SKILL.md → octocode-skills.octocode-graph-eval; the runnable sensors here are scripts/style-lint.mjs --self-test (rules still fire) and scripts/refresh-word-list.mjs --dry-run (word-list drift).© bgauryy, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
SKILL.md and 36 other files (scripts, references, assets) in skills/octocode-documentation of bgauryy/octocode.
Open the folder on GitHubat commit c265e3f
Evidence-Backed Documentation 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 |
|---|---|---|---|---|---|---|
| Evidence-Backed Documentation Writer this skillbgauryy/octocode | 949 | — | ~2k | Automated safety check: Pass | MIT | |
| Technical Writingrsmdt/the-startup | 560 | — | ~1.3k | Automated safety check: Pass | MIT | |
| Technical Documentation Templatesbybren-llc/safe-agentic-workflow | 423 | — | ~1.2k | Automated safety check: Pass | MIT | |
| Technical Documentationkid-sid/claude-spellbook | 190 | — | ~3.4k | Automated safety check: Notes | MIT | |
| Simplified Technical Englishathola/claude-night-market | 341 | — | ~2k | Automated safety check: Pass | MIT | |
| Obsidian WriterAtmosphere/atmosphere | 3.8k | — | ~2.6k | Automated safety check: Pass | Apache-2.0 |
rsmdt/the-startup
Create architectural decision records (ADRs), system documentation, API documentation, and operational runbooks.
bybren-llc/safe-agentic-workflow
Documentation templates for ADRs, runbooks, architecture docs, and knowledge transfer documents. Use when creating Architecture Decision Records, writing…
kid-sid/claude-spellbook
A skill your agent uses when writing a README, documenting an API with OpenAPI, drafting a runbook for on-call engineers, authoring a technical spec or ADR, or setting up docs-as-code with…
athola/claude-night-market
Applies an ASD-STE100-derived register to operator and procedural text.
Atmosphere/atmosphere
Write well-formatted notes to the atmosphere-vault Obsidian knowledge base.
pchalasani/claude-code-tools
Literature-backed English technical-prose writing rules (agent-style, 21 rules).
bgauryy/octocode
Runs blind pairwise comparisons of Octocode against a gh-based baseline over markdown research questions, scored by total characters through the model rather than self-report.
bgauryy/octocode
Researches code with evidence: traces callers, imports and cross-repo links, diagnoses failures and reports findings with exact file and line references and a confidence label.
bgauryy/octocode
Poses and animates a 22-bone anatomical humanoid rig with joint range-of-motion limits, using a Node CLI, a Three.js viewer and WebMCP tools an agent can drive live.
bgauryy/octocode
Finds, rates, reviews, creates, improves, installs and syncs Agent Skill folders from local workspaces, registries or remote sources, with a user gate before any write.
bgauryy/octocode
Walks an idea through framing, diverging into options, researching evidence and stress-testing before converging on a build, prototype, narrow or park decision.
bgauryy/octocode
A skill your agent uses when a live page needs Chrome DevTools/CDP evidence: network failures, console errors, performance, DOM/CSS actionability, screenshots/PDF, cookies/storage…
Categories
Writes, repairs and copyedits project docs against the Google developer documentation style guide, verifying claims in the repository before stating them. md, ADRs, migration guides, docstrings, alt text and prose linting. It follows the flow understand, research, classify, outline gate, write, style and verify.
Evidence-Backed Documentation Writer fits situations like: rewriting a stale or inaccurate README against the real code; copyediting a doc to match the Google developer style guide; writing an ADR, runbook or migration guide from repository evidence; restructuring documentation using Diátaxis.
Run `npx skills add bgauryy/octocode --skill octocode-documentation -a claude-code`. Or copy the skill folder (skills/octocode-documentation in bgauryy/octocode) into .claude/skills/octocode-documentation in your project. Claude Code loads it when a task matches its description.
Run `npx skills add bgauryy/octocode --skill octocode-documentation -a codex`. Or copy the skill folder (skills/octocode-documentation in bgauryy/octocode) into .agents/skills/octocode-documentation in your project. Codex loads it when a task matches its description.
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add bgauryy/octocode --skill octocode-documentation -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/octocode-documentation, .gemini/skills/octocode-documentation, .github/skills/octocode-documentation and .opencode/skills/octocode-documentation in your project.
SKILL.md names no scripts, command-line tools or credentials: Evidence-Backed Documentation Writer is instructions for the agent only.
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.
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. The check reads SKILL.md only: the scripts in the folder are not scanned, so read them before running anything.
Evidence-Backed Documentation Writer is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
About 2k tokens (SKILL.md is roughly 8.1k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 24k tokens, read only when the agent opens those files.
Skills that share tags, products or a category with Evidence-Backed Documentation Writer: Technical Writing (rsmdt/the-startup, 560 stars), Technical Documentation Templates (bybren-llc/safe-agentic-workflow, 423 stars), Technical Documentation (kid-sid/claude-spellbook, 190 stars) and Simplified Technical English (athola/claude-night-market, 341 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
bgauryy (a GitHub user) maintains it in bgauryy/octocode, which has 949 GitHub stars. The repository holds 12 skills in this directory. The repository was last updated on October 9, 2026.
Source: bgauryy/octocode on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.