PlugWiki

technical-writing skill (riekelt) for Claude Code: a house style for technical documents

Makes Claude write technical documents in a strict house style: conclusion first, every claim traceable, one fact in one place.

Installs
21.3K
on skills.sh
Stars
36
on GitHub
Files
2
besides SKILL.md
Updated
Sep 2026
last repo commit

technical-writing is the core skill of riekelt's technical-writer set. It tells Claude to read two comparable documents first, classify the document as normative, descriptive, historical, runbook or reference, and state its audience and purpose before drafting. It then applies seven hard rules, such as no em dashes and no claim without a source, plus a style file and a truth file. It loads whenever Claude produces repository-bound text longer than a paragraph. It governs documents, not chat replies, and the ten other skills in the set build on it.

Good for

  • Developers who write specs, READMEs and design docs with Claude and want them checkable
  • Teams that want AI-written documents without filler or machine-sounding phrasing
  • Anyone keeping a docs folder that must stay true to the code

Install technical-writing

Claude Code

  1. 1

    Copy this prompt.

    Install the technical-writing skill in Claude Code. Run this command:
    
    /plugin marketplace add riekelt/technical-writer
    /plugin install technical-writer@technical-writer
    
    Then check that it loaded and tell me how to use it.
  2. 2

    Paste it into Claude Code. It shows the change and asks before running it.

Pick one route, not both, or you get every skill twice. The other ten skills in the set build on this one, so the plugin is the easiest way to get them together.

From the project README. Source.

What's in the skill

When it loads

Use when writing, restructuring, or revising any technical document - specs, design docs, READMEs, reference documentation, plans, reports - or any prose that must survive being read twice by someone in a hurry. Encodes the house style, the truth and sourcing rules, and the banned-constructions list. Use whenever you produce repository-bound text longer than a paragraph, even if nobody says "document". Foundation for the sibling document-type skills.

Sections in SKILL.md

  1. Overview
  2. When to invoke
  3. Non-goals
  4. Mandatory checkpoint before drafting
  5. Read first, then write
  6. Rule precedence
  7. Classify the document before editing it
  8. Hard rules
  9. Workflow
  10. Audience
  11. Common mistakes

Key facts

Installs on skills.sh
21,293 as of 2026-11-02
Last repo commit
2026-09-13

What it includes

  • States kind, audience, purpose and non-goals before any draft

    Before a new document or a large section, Claude writes down the document kind, who reads it, the verb the reader must do and what the document will not cover. It asks you only when an unknown would change the audience or scope.

    Read · Checkpoint before drafting

  • Reads up to two similar documents and the folder's README index

    Claude reads comparable documents in the same folder, adopts their structure and tone, checks for a README that indexes the folder, and checks whether the topic already has a home. It adds the new document to the index when one exists.

    Files · Read first, then write

  • Five kinds, each with its own edit rule

    Normative, descriptive, historical, runbook and reference documents are edited differently. A contract that code violates is not watered down, a changelog is never rewritten, and a runbook step must have been run.

    Read · Classify the document

  • Seven rules that apply in every document

    No em dashes, en dashes or double hyphens. No changelog section or last-updated field inside a document. No delivery history in prose. No claim without a traceable source. One fact in one home. Accepted decisions stay unchanged. Headings in sentence case.

    Write · Hard rules

  • Six steps from read-first to a verified draft

    Read first, declare the checkpoint, draft conclusion first, ground every claim with a confidence label, run a style pass, then verify with the reviewing-technical-prose checklist.

    Write · Workflow

  • Sentence rules, word choice, headings, banned constructions, formatting

    A style file with five sections. It carries the banned-constructions list that catches machine-sounding text and two self-checks: read it aloud, and delete the product name to see if the text still makes sense.

    Read · references/style.md

  • Grounding, confidence labels, reviewed documents, staleness

    A truth file with six sections: grounding claims, confidence labels, fact versus proposal versus hypothesis, reviewed documents, keeping documents true, and rules about rules.

    Read · references/truth.md

  • Sends each document type to one of the sibling skills

    A table of 11 task types, such as postmortem, changelog or API reference, with the sibling skill to load on top of this one.

    Read · Routing table

From the official docs

Permissions

Low risk

Claude edits documents in your repository, so a careless request can rewrite text you wanted kept.

What it can do

  • Read your data
  • Create and change things
  • Delete things
  • Read-only mode

Watch out for

  • It edits documents in your repo

    The skill drafts and revises documents and updates a README index. Review the diff before you commit. github.com

  • The plugin route adds 2 agents and 2 commands

    The plugin ships agents prose-reviewer and doc-grounder (both with Read, Glob, Grep and Bash tools) and the commands /prose-review and /ground-docs. The plugin folder has no hooks or MCP config. Use the skills command in the install box if you want only this skill. github.com

Technical details
Turning on read-onlyNo read-only mode. The skill tells Claude to write or edit documents.
Sign-in and keysSKILL.md names no account or API key.
Data retentionSKILL.md names no logging or telemetry.
Scopes
  • Claude reads neighbouring documents and writes or edits documents in your repo

  • Adds new documents to the folder's README index when one exists

Questions

What does the technical-writing skill do?

It makes Claude write technical documents to a fixed house style. Claude states the audience and purpose first, puts the conclusion first, ties each claim to a source and avoids a list of banned phrases that make text sound machine-written.

How do I install technical-writing?

Use the install box at the top of this page. The plugin route installs this skill together with the ten that build on it.

Do I need the other ten skills?

No. The ten others list this one as required background, but this skill does not need them to run. SKILL.md has a routing table that says which sibling to load on top for a given document type (for example writing-runbooks), and its last workflow step loads reviewing-technical-prose for the delivery checklist. The skills command in the install box installs only technical-writing; the plugin route installs all 11. Our advice: if you want that final checklist, add --skill reviewing-technical-prose to the skills command.

Does it work for documents that are not in English?

Yes for structure and truth rules. SKILL.md says documents keep their own language, so a Dutch document is written and reviewed in Dutch. The word lists in references/style.md are English-specific.

Does it change how Claude answers in chat?

No. SKILL.md says the rules govern documents, not chat replies, and apply to running prose rather than reference lists.

Is technical-writing safe to install?

The skill folder holds only SKILL.md and two reference files, so it bundles no scripts. It tells Claude to add new documents to a folder's README index and to read neighbouring documents first. Review the changes it makes to your documents, as you would any edit.

Can I use technical-writing in the Claude app or Cursor?

The README documents Claude Code, and the repo also ships Codex and Cursor plugin manifests. It does not mention the Claude app. Our advice: this page offers no Claude app upload because the skill works on documents inside a repository, so use Claude Code or Codex.

Information

updated Nov 2, 2026

Folder
plugins/technical-writer/skills/technical-writing

riekelt/technical-writerskills.sh

Sources

Docs, issue trackers and discussions this page is built from.

Show all 7
  1. README · github.com
  2. marketplace.json · github.com
  3. technical-writing on skills.sh · skills.sh
  4. SKILL.md · github.com
  5. LICENSE · github.com
  6. references/style.md · github.com
  7. references/truth.md · github.com

Updated Nov 2, 2026.