Agent skill

Technical Writer

by curiositech in curiositech/some_claude_skills

Expert technical documentation specialist for developer docs, API references, and runbooks.

MITAuto-check passedWriting & Content

Install Technical Writer

skills CLI
$ npx skills add curiositech/some_claude_skills --skill technical-writer -a claude-code

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

GitHub CLI
$ gh skill install curiositech/some_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/curiositech/some_claude_skills.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/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
243
Token cost
~1.4k tokens
SKILL.md length
465 words
Files
8 (incl. scripts, references)
Skills in repo
109
Repo updated
First seen
Licence
MIT

At a glance

Expert technical documentation specialist for developer docs, API references, and runbooks.

  • Works in 10 steps: Wall of Text → Outdated Examples → Missing Prerequisites → …
  • Tasks that involve Technical writing
  • SKILL.md covers Quick Start, Core Capabilities, Diátaxis Framework and Reference Templates, plus 5 more sections
  • Runs Shell scripts from its folder

What it does

Technical Writer is an agent skill from curiositech/some_claude_skills. Expert technical documentation specialist for developer docs, API references, and runbooks. Activate on: documentation, docs, README, API reference, technical writing, user guide, runbook, ADR, changelog, release notes, tutorial, how-to guide. NOT for: marketing copy (use copywriting skills), blog posts (use content skills), code comments (handled by developers).

Its SKILL.md is about 1.4k tokens, which your agent loads only when the skill is triggered. The skill folder holds 10 other files, including scripts and reference files (for example `.claude-plugin/plugin.json`, `CHANGELOG.md` and `references/adr-template.md`).

It sits in Writing & Content, covering Technical writing, Technical documentation and Runbooks and postmortems. The repository describes itself as: Claude skills that make my life easier. The licence is MIT.

When your agent uses it

  • Tasks that involve Technical writing
  • Tasks that involve Technical documentation
  • Tasks that involve Runbooks and postmortems

Example prompts

  • “/technical-writer”

Requirements

  • A Bash shell
  • Pre-approved tools (allowed-tools): Read, Write, Edit, Bash(npm run docs:*,mkdocs:*,docusaurus:*)

Workflow steps

10 steps, taken from the step headings in SKILL.md.

  1. Wall of Text
  2. Outdated Examples
  3. Missing Prerequisites
  4. Expert Blindness
  5. No Error Guidance
  6. Broken Links
  7. Inconsistent Formatting
  8. Missing Context
  9. Stale Screenshots
  10. No Versioning

What it can do on your machine

Read from SKILL.md and the folder at commit 6713fc7. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves these tools, so the agent can use them without asking each time:

    • Read
    • Write
    • Edit
    • Bash(npm run docs:*
    • mkdocs:*
    • docusaurus:*)

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Ships 1 file in scripts/ (Shell), which the agent can run.

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

  • Network

    Links to these hosts (documentation or services it may open):

    • diataxis.fr
    • developers.google.com
    • writethedocs.org
    • keepachangelog.com
    • adr.github.io

    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 1.4k tokens when it runs, and up to ~6.3k if it reads all its reference files. Until then it costs about 96 tokens; SKILL.md has 465 words of instructions outside code blocks.

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

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); the scripts in this folder are not scanned.

SKILL.md

The full file from curiositech/some_claude_skills at commit 6713fc7, republished under its MIT licence (© curiositech). 465 words, ~1,372 tokens.

Download SKILL.mdSave it as .claude/skills/technical-writer/SKILL.md (or your agent's skills folder). This skill also uses 7 other files; get the full folder from GitHub.
name
technical-writer
description
Expert technical documentation specialist for developer docs, API references, and runbooks. Activate on: documentation, docs, README, API reference, technical writing, user guide, runbook, ADR, changelog, release notes, tutorial, how-to guide. NOT for: marketing copy (use copywriting skills), blog posts (use content skills), code comments (handled by developers).
allowed-tools
Read, Write, Edit, Bash(npm run docs:*,mkdocs:*,docusaurus:*)
metadata.category
Content & Writing
metadata.tags
documentation, readme, api-docs, tutorials, runbooks

Technical Writer

Expert technical documentation specialist focusing on developer documentation, API references, system architecture docs, runbooks, and knowledge base articles.

Quick Start

  1. Identify doc type using Diátaxis: Tutorial, How-to, Explanation, or Reference
  2. Know your audience - what they know, what they need to accomplish
  3. Start with structure - outline before writing, use templates
  4. Include working examples - all code must be tested and runnable
  5. Add troubleshooting - anticipate common problems
  6. Validate completeness - links work, steps accurate, nothing assumed

Core Capabilities

Doc TypePurposeKey Characteristics
TutorialsLearning-orientedHands-on, step-by-step introduction
How-to GuidesTask-orientedSolve specific problems
ExplanationsUnderstanding-orientedBackground, context, concepts
ReferencesInformation-orientedAccurate, complete, searchable

Diátaxis Framework

              PRACTICAL                    THEORETICAL
        ┌──────────────────────┬──────────────────────┐
LEARNING│     TUTORIALS        │    EXPLANATIONS      │
        │  "Learning by doing" │  "Understanding why" │
        ├──────────────────────┼──────────────────────┤
WORKING │    HOW-TO GUIDES     │     REFERENCE        │
        │  "Solve problems"    │  "Look up facts"     │
        └──────────────────────┴──────────────────────┘

Reference Templates

Complete templates in ./references/:

TemplateUse Case
readme-template.mdProject README with all essential sections
adr-template.mdArchitecture Decision Records
api-reference-template.mdREST API documentation
runbook-template.mdOperational procedures

Anti-Patterns (10 Critical Mistakes)

1. Wall of Text

Symptom: Dense paragraphs, no headings or visual breaks Fix: Headings, bullet points, tables, code blocks, whitespace

2. Outdated Examples

Symptom: Code samples that don't compile or use deprecated APIs Fix: Test all examples in CI, version-lock dependencies, add "last verified" dates

3. Missing Prerequisites

Symptom: Tutorials assume knowledge/setup without stating it Fix: List prerequisites upfront, link to setup guides, specify versions

4. Expert Blindness

Symptom: Skipping "obvious" steps that aren't obvious to beginners Fix: Have newcomers test docs, include all steps, explain the "why"

5. No Error Guidance

Symptom: Happy path only, no troubleshooting Fix: Include common errors and solutions, link to support channels

Symptom: 404s to moved or deleted pages Fix: Link checking in CI, relative links where possible, redirects for moved content

Show full SKILL.md (193 more words)Show less
7. Inconsistent Formatting

Symptom: Different styles, code block languages, heading levels Fix: Style guide, linting (markdownlint), templates for common doc types

8. Missing Context

Symptom: Docs assume reader knows system architecture Fix: Brief context at top, link to architecture docs, explain "where this fits"

9. Stale Screenshots

Symptom: UI screenshots from 3 versions ago Fix: Automate screenshot capture, note UI version, prefer text over images

10. No Versioning

Symptom: Docs don't match user's installed version Fix: Version selector, version badges, maintain docs per major version

Quality Checklist

Structure:

  • Follows Diátaxis framework (tutorial/how-to/explanation/reference)
  • Appropriate for target audience level
  • Consistent formatting and style
  • Updated table of contents

Content:

  • Code examples are tested and runnable
  • All links work (no 404s)
  • Version information where relevant
  • Includes troubleshooting section

Completeness:

  • Prerequisites listed upfront
  • All steps included (no expert blindness)
  • Error scenarios covered
  • Related documentation linked

Validation Script

Run ./scripts/validate-docs.sh to check:

  • README completeness
  • Documentation structure
  • ADR format compliance
  • Broken links
  • Common documentation issues

Documentation Tools

Static Sites: Docusaurus, MkDocs, VitePress, Astro API Docs: Swagger/Redoc, Stoplight, ReadMe.io Diagrams: Mermaid, PlantUML, Excalidraw, Diagrams.net

External Resources

© curiositech, 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 7 other files (scripts, references) in .claude/skills/technical-writer of curiositech/some_claude_skills.

  • SKILL.md
  • .claude-plugin/plugin.json
  • CHANGELOG.md
  • references/adr-template.md
  • references/api-reference-template.md
  • references/readme-template.md
  • references/runbook-template.md
  • scripts/validate-docs.sh

Open the folder on GitHubat commit 6713fc7

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 skillcuriositech/some_claude_skills243—~1.4kAutomated safety check: PassMIT
Persuasive Technical Writingmtarcure/claude-vibe-squad163—~1.8kAutomated safety check: PassMIT
Technical Writingfrappe/skills146—~1.1kAutomated safety check: PassNone
Technical Writingcitypaul/.dotfiles739—~2.5kAutomated safety check: PassMIT
Change Documentation Writerjsmastery-pro/skills1.4k—~2.4kAutomated safety check: NotesMIT
Content Modelguardana/guardana129—~1.2kAutomated safety check: PassApache-2.0

Similar skills

  • Persuasive Technical Writing

    mtarcure/claude-vibe-squad

    A skill your agent uses when drafting or revising long-form persuasive technical prose (an essay, post-mortem, launch narrative, or public technical release for X or the web) where the writing must…

    163 GitHub stars~1.8k tokensUpdated 17 days ago
    Writing & ContentAuto-check passed
  • Technical Writing

    frappe/skills

    Write prose in "Simplified Technical English". An agent skill from frappe/skills.

    146 GitHub stars~1.1k tokensUpdated 7 days ago
    DevelopmentAuto-check passed
  • Technical Writing

    citypaul/.dotfiles

    Writing developer-facing prose that can be skimmed first and trusted enough to finish — READMEs, guides, tutorials, reference docs, proposals, PR descriptions, release notes.

    739 GitHub stars~2.5k tokensUpdated 5 days ago
    Writing & ContentAuto-check passed
  • Change Documentation Writer

    jsmastery-pro/skills

    Writes PR descriptions, changelog entries, release notes and postmortems from the actual commits and diff, and saves each one in the right place.

    1.4k GitHub stars~2.4k tokensUpdated 1 mo ago
    DevelopmentAuto-check: notes
  • Content Model

    guardana/guardana

    Route wording work to GPT (codex CLI) or Gemini (agy CLI) instead of writing it with Claude — landing-page copy, a readability rewrite of a README or docs page, attack and judge prompts for a rule…

    129 GitHub stars~1.2k tokensUpdated today
    DevelopmentAuto-check passed
  • Documentation Strategy

    rampstackco/claude-skills

    Design and run a documentation system for a team or product.

    940 GitHub stars~3.3k tokensUpdated yesterday
    Writing & ContentAuto-check passed

More from curiositech/some_claude_skills

All 109 skills in this repo
  • Crisis Detection Intervention AI

    curiositech/some_claude_skills

    Detect crisis signals in user content using NLP, mental health sentiment analysis, and safe intervention protocols.

    243 GitHub starsUsed in 3 repos~3.8k tokens
    Auto-check passed
  • Form Validation Architect

    curiositech/some_claude_skills

    End-to-end form handling with react-hook-form, Zod schemas, validation patterns, error messaging, field arrays, and multi-step wizards.

    243 GitHub stars~3.8k tokensUpdated 1 mo ago
    Auto-check passed
  • Competitive Cartographer

    curiositech/some_claude_skills

    Strategic analyst that maps competitive landscapes, identifies white space opportunities, and provides positioning recommendations.

    243 GitHub starsUsed in 1 repo~1.3k tokens
    Auto-check passed
  • GitHub Actions Pipeline Builder

    curiositech/some_claude_skills

    Build production CI/CD pipelines with GitHub Actions. An agent skill from curiositech/some_claude_skills.

    243 GitHub stars~2.8k tokensUpdated 1 mo ago
    Auto-check: notes
  • Computer Vision Pipeline

    curiositech/some_claude_skills

    Build production computer vision pipelines for object detection, tracking, and video analysis.

    243 GitHub starsUsed in 1 repo~4k tokens
    Auto-check passed
  • Design Archivist

    curiositech/some_claude_skills

    Long-running design anthropologist that builds comprehensive visual databases from 500-1000 real-world examples, extracting color palettes, typography patterns, layout systems, and interaction…

    243 GitHub starsUsed in 1 repo~1.6k tokens
    Auto-check passed

Questions about Technical Writer

What does Technical Writer do?

Expert technical documentation specialist for developer docs, API references, and runbooks. Technical Writer is an agent skill from curiositech/some_claude_skills. Expert technical documentation specialist for developer docs, API references, and runbooks.

When should I use Technical Writer?

Technical Writer fits situations like: tasks that involve Technical writing; tasks that involve Technical documentation; tasks that involve Runbooks and postmortems.

How do I install Technical Writer in Claude Code?

Run `npx skills add curiositech/some_claude_skills --skill technical-writer -a claude-code`. Or copy the skill folder (.claude/skills/technical-writer in curiositech/some_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 curiositech/some_claude_skills --skill technical-writer -a codex`. Or copy the skill folder (.claude/skills/technical-writer in curiositech/some_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 curiositech/some_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 a shell for the scripts in its folder. Our summary lists: A Bash shell. Its frontmatter pre-approves these tools: Read, Write, Edit, Bash(npm run docs:*,mkdocs:*,docusaurus:*).

Does Technical Writer access the network?

SKILL.md names 5 domains. As links in the text: diataxis.fr, developers.google.com, writethedocs.org, keepachangelog.com and adr.github.io. 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. The check reads SKILL.md only: the scripts in the folder are not scanned, so read them before running anything.

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.4k tokens (SKILL.md is roughly 5.5k 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 4.9k 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: Persuasive Technical Writing (mtarcure/claude-vibe-squad, 163 stars), Technical Writing (frappe/skills, 146 stars), Technical Writing (citypaul/.dotfiles, 739 stars) and Change Documentation Writer (jsmastery-pro/skills, 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?

curiositech (a GitHub organization) maintains it in curiositech/some_claude_skills, which has 243 GitHub stars. The repository holds 109 skills in this directory. The repository was last updated on September 6, 2026.

Source: curiositech/some_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.