Agent skill

Technical Writer

by OneWave-AI in OneWave-AI/claude-skills

Writes and restructures technical documentation - READMEs, tutorials, how-to guides, user guides, architecture docs, onboarding guides, runbooks and SOPs, troubleshooting guides, release notes, and…

MITAuto-check: notesDevelopment

Install Technical Writer

skills CLI
$ npx skills add OneWave-AI/claude-skills --skill technical-writer -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install OneWave-AI/claude-skills technical-writer --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/OneWave-AI/claude-skills.git skills-src && mkdir -p .claude/skills && cp -r skills-src/technical-writer .claude/skills/technical-writer && rm -rf skills-src

Use ~/.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/

Facts

Skill name
technical-writer
GitHub stars
328
Token cost
~1.2k tokens
SKILL.md length
608 words
Files
3 (incl. references)
Skills in repo
69
Repo updated
First seen
Licence
MIT

At a glance

Writes and restructures technical documentation - READMEs, tutorials, how-to guides, user guides, architecture docs, onboarding guides, runbooks and SOPs, troubleshooting guides, release notes, and…

  • Works in 6 steps: Name the reader and the job. One… → Pick the document type. Each type… → Gather facts from the source, not from… → …
  • The user asks to document a project
  • SKILL.md covers Workflow, Worked example and Failure modes
  • Calls npm and docker; needs STRIPE_SECRET_KEY

What it does

Technical Writer is an agent skill from OneWave-AI/claude-skills. Writes and restructures technical documentation - READMEs, tutorials, how-to guides, user guides, architecture docs, onboarding guides, runbooks and SOPs, troubleshooting guides, release notes, and knowledge base articles - grounded in the actual code or product, with commands and examples verified where possible. Use when the user asks to document a project, feature, system, or process, write or fix a README, explain a codebase to new developers, turn notes into a guide, or make existing docs clearer. For…

Its SKILL.md is about 1.2k tokens, which your agent loads only when the skill is triggered. The skill folder holds 3 other files, including reference files (for example `references/style-guide.md` and `references/templates.md`).

It sits in Development, covering Technical writing, Technical documentation and Agent instruction files. The repository describes itself as: 200+ production-ready Claude Code skills for sales, marketing, design, engineering, and AI agent architecture. Built and maintained by OneWave AI. The licence is MIT.

When your agent uses it

  • The user asks to document a project
  • Explain a codebase to new developers
  • Turn notes into a guide
  • Make existing docs clearer

Example prompts

  • “Use the technical-writer skill to write and restructures technical documentation - READMEs, tutorials, how-to guides, user guides, architecture…”
  • “/technical-writer”

Requirements

  • Docker
  • A credential in STRIPE_SECRET_KEY

Workflow steps

6 steps, taken from the first numbered list in SKILL.md.

  1. Name the reader and the job. One sentence: "[Reader] needs to [do what] and already knows [what]." A new contributor setting up the repo…
  2. Pick the document type. Each type answers one question; mixing them is the most common reason docs feel unclear.
  3. Gather facts from the source, not from memory. In a codebase, read the entry points, package.json / pyproject.toml / Makefile scripts…
  4. Draft with the template, then apply references/style-guide.md. Lead with the most common task. Put prerequisites before step 1, not in the…
  5. Test the doc. If you can run commands, walk the steps in order in a clean state and fix anything that fails or needs an unstated step…
  6. Deliver as the actual file (for example README.md or docs/setup.md), not wrapped in commentary. After it, list any [VERIFY] markers…

What it can do on your machine

Read from SKILL.md and the folder at commit fc5b785. 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

    Shell commands in SKILL.md call:

    • npm
    • docker

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md. Its commands use npm and docker, which can reach the network depending on how they are called.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names these keys or tokens, usually read from environment variables:

    • STRIPE_SECRET_KEY

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Technical Writer loads about 1.2k tokens when it runs, and up to ~2.8k if it reads all its reference files. Until then it costs about 167 tokens; SKILL.md has 608 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~167
When it runs · the whole SKILL.md, loaded when a task matches
~1.2k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~2.8k

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: notes

The automated check noted patterns worth knowing about, such as sudo or a known installer.

  • NoteMentions a .env fileSKILL.md:41
    e and install -> copy `.env.example` to `.env.local` and what each variable is for -> `docker compose up -d` -> `npm run

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 OneWave-AI/claude-skills at commit fc5b785, republished under its MIT licence (© OneWave-AI). 608 words, ~1,194 tokens.

Download SKILL.mdSave it as .claude/skills/technical-writer/SKILL.md (or your agent's skills folder). This skill also uses 2 other files; get the full folder from GitHub.
name
technical-writer
description
Writes and restructures technical documentation - READMEs, tutorials, how-to guides, user guides, architecture docs, onboarding guides, runbooks and SOPs, troubleshooting guides, release notes, and knowledge base articles - grounded in the actual code or product, with commands and examples verified where possible. Use when the user asks to document a project, feature, system, or process, write or fix a README, explain a codebase to new developers, turn notes into a guide, or make existing docs clearer. For endpoint-by-endpoint API reference or OpenAPI specs, use api-documentation-writer; for CLAUDE.md or AGENTS.md files, use claude-md-writer.

Technical Writer

Write documentation that lets a specific reader finish a specific task without asking anyone.

Workflow

  1. Name the reader and the job. One sentence: "[Reader] needs to [do what] and already knows [what]." A new contributor setting up the repo, an admin configuring SSO, and an executive evaluating the architecture need different documents. If the request does not say, infer from context and state the assumption at the top of your draft.

  2. Pick the document type. Each type answers one question; mixing them is the most common reason docs feel unclear.

    Reader wants to...TypeShape
    learn by doing, first timeTutorialOne guaranteed-to-work path, start to finish
    complete a known taskHow-to guideGoal, prerequisites, numbered steps, verify
    look something upReferenceTables and lists, complete and consistent
    understand whyExplanation / architectureContext, design, trade-offs
    fix something brokenTroubleshootingSymptom, cause, fix

    A README is a front door: what it is, quickstart, links to the rest. Templates for every type are in references/templates.md.

  3. Gather facts from the source, not from memory. In a codebase, read the entry points, package.json / pyproject.toml / Makefile scripts, config files, env var usage (grep -r "process.env\|os.environ"), and existing docs. Every command, flag, file path, env var, and default value in the doc must come from something you read or ran. When a fact cannot be verified, mark it [VERIFY: ...] rather than guessing.

  4. Draft with the template, then apply references/style-guide.md. Lead with the most common task. Put prerequisites before step 1, not in the middle.

  5. Test the doc. If you can run commands, walk the steps in order in a clean state and fix anything that fails or needs an unstated step. Otherwise, reread as the reader: is every step possible with only what the doc and prerequisites provide?

  6. Deliver as the actual file (for example README.md or docs/setup.md), not wrapped in commentary. After it, list any [VERIFY] markers, assumptions about the reader, and what should trigger an update (a config format change, a new required env var).

Show full SKILL.md (269 more words)Show less

Worked example

Request: "Write setup docs for this repo for new devs."

  • Reader and job: a developer who knows TypeScript but not this repo needs a running local environment and a passing test suite.
  • Type: how-to guide (a known task), plus a short README section that links to it.
  • Facts gathered: package.json scripts dev, test, db:migrate; .env.example lists DATABASE_URL and STRIPE_SECRET_KEY; docker-compose.yml runs Postgres 17; engines.node is >=22.
  • Draft: Prerequisites (Node 22+, Docker) -> clone and install -> copy .env.example to .env.local and what each variable is for -> docker compose up -d -> npm run db:migrate -> npm run dev with the expected URL -> npm test with the expected output -> Troubleshooting for port 5432 already in use and a missing DATABASE_URL.
  • Test: running the steps revealed a seed step (npm run db:seed) that the app needs; it was added as step 6.

Failure modes

  • Invented details. A plausible flag or env var that does not exist costs the reader more than a missing one. Verify or mark it.
  • Wall of prose where steps belong. If the reader does things in order, number them. One action per step.
  • Missing expected results. After each command that produces output, show what success looks like so the reader knows they are on track.
  • Mixing types. A tutorial that stops to explain every design decision loses the learner. Link to the explanation instead.
  • Stale screenshots and versions. Prefer text over screenshots for UI that changes. Pin versions only where the version matters, and say where the version comes from.
  • Documenting the happy path only. Add the two or three failures a new reader is most likely to hit.

© OneWave-AI, MIT. 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 2 other files (references) in technical-writer of OneWave-AI/claude-skills.

  • SKILL.md
  • references/style-guide.md
  • references/templates.md

Open the folder on GitHubat commit fc5b785

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.

Technical Writer compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Technical Writer this skillOneWave-AI/claude-skills328—~1.2kAutomated safety check: NotesMIT
Technical Writerfinos/morphir213—~4.4kAutomated safety check: PassApache-2.0
Document Generatorgarrytan/gstack136k—~11kAutomated safety check: NotesMIT
Technical Writing Standardcursor/plugins10k10 repos~2.4kAutomated safety check: PassNone
Heym Documentation Articlesheymrun/heym1.4k—~780Automated safety check: PassCustom licence
Release Docs SyncUfoMiao/zcf6.1k—~4kAutomated safety check: PassMIT

Similar skills

  • Technical Writer

    finos/morphir

    Assists with writing and maintaining Morphir technical documentation.

    213 GitHub stars~4.4k tokensUpdated today
    DevelopmentAuto-check passed
  • Document Generator

    garrytan/gstack

    Writes missing documentation from scratch for a feature, a module or a whole project, organized as tutorial, how-to, reference and explanation pages.

    136k GitHub stars~11k tokensUpdated today
    DevelopmentAuto-check: notes
  • Official

    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.

    10k GitHub starsUsed in 10 repos~2.4k tokens
    Writing & ContentAuto-check passed
  • Creates and updates documentation articles for the Heym platform: category choice, manifest entry, markdown file and cross-links from existing pages.

    1.4k GitHub stars~780 tokensUpdated today
    Writing & ContentAuto-check passed
  • Compares code changes since the last Git tag with the multilingual docs and CLAUDE.md, then updates them or only reports mismatches with --check-only.

    6.1k GitHub stars~4k tokensUpdated 1 mo ago
    DevelopmentAuto-check passed
  • Aholo Viewer Docs

    manycoretech/aholo-viewer

    Guides writing and maintaining Aholo Viewer documentation: README, AGENTS.md, architecture notes, bilingual manual pages and AI collaboration guides.

    1.1k GitHub stars~341 tokensUpdated today
    Writing & ContentAuto-check passed

More from OneWave-AI/claude-skills

All 69 skills in this repo
  • CRM Data Cleanup

    OneWave-AI/claude-skills

    Finds duplicate and junk records in a CRM CSV export with fuzzy matching, normalizes fields and writes a reviewable merge plan plus import-ready files without touching the live CRM.

    328 GitHub stars~2.5k tokensUpdated 7 days ago
    Auto-check passed
  • Design Export Repair

    OneWave-AI/claude-skills

    Repairs broken decks and PDFs exported from Claude Design or similar AI deck generators: clipped text, wrong fonts and corrupted .pptx package structure.

    328 GitHub stars~2.6k tokensUpdated 7 days ago
    Auto-check passed
  • Bi Measure Builder

    OneWave-AI/claude-skills

    Writes, explains, debugs, and optimizes BI calculations - Power BI / Fabric DAX measures and calculated columns, Tableau calculated fields (FIXED/INCLUDE/EXCLUDE LOD expressions, table…

    328 GitHub stars~2.2k tokensUpdated 7 days ago
    Auto-check passed
  • Bookkeeping Close

    OneWave-AI/claude-skills

    Categorizes transactions, reconciles bank and card statements to the ledger, works a month-end checklist and prepares a close package, without ever forcing a balance.

    328 GitHub stars~2k tokensUpdated 7 days ago
    Auto-check passed
  • CSV and Excel Merger

    OneWave-AI/claude-skills

    Combines CSV, TSV and Excel files into one verified table with pandas, by stacking or joining, mapping columns, normalizing keys and removing duplicates.

    328 GitHub stars~1.6k tokensUpdated 7 days ago
    Auto-check passed
  • Sec Filing Puller

    OneWave-AI/claude-skills

    Pulls financial statement numbers for US public companies straight from SEC EDGAR's free official XBRL APIs (companyfacts, companyconcept, frames, submissions) into a cited table.

    328 GitHub stars~2.1k tokensUpdated 7 days ago
    Auto-check passed

Questions about Technical Writer

What does Technical Writer do?

Writes and restructures technical documentation - READMEs, tutorials, how-to guides, user guides, architecture docs, onboarding guides, runbooks and SOPs, troubleshooting guides, release notes, and…. Technical Writer is an agent skill from OneWave-AI/claude-skills. Writes and restructures technical documentation - READMEs, tutorials, how-to guides, user guides, architecture docs, onboarding guides, runbooks and SOPs, troubleshooting guides, release notes, and knowledge base articles - grounded in the actual code or product, with commands and examples verified where possible.

When should I use Technical Writer?

Technical Writer fits situations like: the user asks to document a project; explain a codebase to new developers; turn notes into a guide; make existing docs clearer.

How do I install Technical Writer in Claude Code?

Run `npx skills add OneWave-AI/claude-skills --skill technical-writer -a claude-code`. Or copy the skill folder (technical-writer in OneWave-AI/claude-skills) 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 OneWave-AI/claude-skills --skill technical-writer -a codex`. Or copy the skill folder (technical-writer in OneWave-AI/claude-skills) 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 OneWave-AI/claude-skills --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?

Going by SKILL.md and its folder, Technical Writer needs the command-line tools its instructions call (npm and docker) and credentials named STRIPE_SECRET_KEY. Our summary lists: Docker; A credential in STRIPE_SECRET_KEY.

Does Technical Writer access the network?

SKILL.md contains no URLs. Its commands use npm and docker, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Technical Writer safe to install?

Our automated static check of SKILL.md found notes only (mentions a .env file), nothing it rates as a warning. It is not a guarantee. Review the folder before installing.

What licence does Technical Writer use?

Technical Writer is published under the MIT 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 1.2k tokens (SKILL.md is roughly 4.8k 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 1.6k tokens, read only when the agent opens those files.

What are the alternatives to Technical Writer?

Skills that share tags, products or a category with Technical Writer: Technical Writer (finos/morphir, 213 stars), Document Generator (garrytan/gstack, 136k 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?

OneWave-AI (a GitHub organization) maintains it in OneWave-AI/claude-skills, which has 328 GitHub stars. The repository holds 69 skills in this directory. The repository was last updated on October 2, 2026.

Source: OneWave-AI/claude-skills on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.