Skill

technical-writing

Clear technical documentation, API docs, architecture decision records, and runbooks.

npx claudepluginhub sethdford/claude-skills --plugin engineer-toolkit

Popularity

Parent stars

Parent forks

Invocation

How this skill is triggered — by the user, by Claude, or both

Slash command

/engineer-toolkit:technical-writing

User invocable

Model invocable

Inline context

Default effort

Context Preview

The summary Claude sees in its skill listing — used to decide when to auto-load this skill

Writing clear, concise technical documentation that engineers actually read.

SKILL.md

45 lines · ~374 tokens

Similar Skills

documentation

12.3k

Writes clear technical documentation: READMEs, API references, runbooks, architecture docs, and onboarding guides for developers and ops teams.

engineering

documentation-writing

Provides templates and best practices for README files, API documentation, user guides, changelogs, inline code comments, and architecture docs.

core

documentation-writing

Provides templates and best practices for writing README files, API documentation, user guides, changelogs, architecture docs, and inline code comments.

all-skills

Stats

Parent stars13

Parent forks2

MaintenanceFair

Last CommitMar 11, 2026

Actions

View Source View Plugin View on GitHub View README

Help us improve

Share bugs, ideas, or general feedback.

Stats

Actions

Help us improve

Share bugs, ideas, or general feedback.

Technical Writing

Writing clear, concise technical documentation that engineers actually read.

Context

You are writing technical documentation. Be clear; use examples; keep it current.

Domain Context

README: Quick start, installation, basic usage

Architecture: Design decisions, component interactions, diagrams

API Docs: Endpoints, parameters, examples, errors

Runbooks: Step-by-step incident response; for panicked engineer

ADR: Architecture Decision Record; why we chose this technology

Instructions

Know Your Audience: Are they users? Operators? Developers?

Start with Purpose: Why are you writing this?

Use Examples: Real examples beat abstract explanation

Be Concrete: "Use HTTPS" not "ensure secure communication"

Structure Clearly: Headings, lists, code blocks

Diagrams: ASCII diagrams or images; visual helps

Keep Current: Outdated docs are worse than no docs

Anti-Patterns

Overly formal language; engineers are busy

No examples; "see code" isn't helpful

Out-of-date docs; misinformation is harmful

Too long; nobody reads walls of text; be concise

No table of contents; hard to navigate