technical-writer

Write and review user-facing documentation using ASD-STE100 Simplified Technical English rules.

Updated May 9, 2026
One-click install
npx skills add https://github.com/natelandau/cc-plugin --skill technical-writer-natelandau
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/natelandau/cc-plugin/tree/main/plugins/natelandau-toolkit/skills/technical-writer
Command: npx skills add https://github.com/natelandau/cc-plugin --skill technical-writer-natelandau

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Documentation often drifts out of sync with the code, buries key facts under filler, and carries AI writing patterns that erode reader trust. This Skill enforces a two-layer discipline: structural decisions about what a document contains, and sentence-level rules from ASD-STE100 Simplified Technical English that keep every sentence clear for non-native readers. ## Core Features & Use Cases - Full-document judgment: Reviews, rewrites, restructures, or replaces READMEs, setup guides, API references, changelogs, runbooks, and commit messages based on the gap between the page and its goal. - ASD-STE100 rule enforcement: Applies 53 rules covering verb forms, approved modals, sentence length limits (20 words procedural, 25 descriptive), condition placement, and one-term-per-concept consistency. - AI slop detection: Ships a catalog of AI writing tropes (bold-first bullets, negative parallelism, fractal summaries) plus a searchable verification checklist for audit mode. - Use Case: Ask it to rewrite an outdated README, and it verifies every command against the code, cuts sections that fail its necessity gates, and delivers prose that survives translation and tired readers. ## Quick Start Ask the assistant to rewrite the project README using the technical-writer skill and verify every command against the source code.

Frequently Asked Questions about technical-writer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write documentation that follows ASD-STE100 rules?

Classify each passage as procedural or descriptive, then apply the matching rules: imperative sentences under 20 words for procedures, simple tenses under 25 words for descriptions. Use only the modals can, will, and must, and keep one term per concept throughout.

What is Simplified Technical English used for in software docs?

Simplified Technical English (ASD-STE100) is a controlled language that removes ambiguity from technical prose. In software documentation it keeps sentences short, bans vague modals like should and could, and makes text safe for non-native readers and machine translation.

Can this skill review existing docs instead of writing new ones?

Yes. Check mode runs the full verification checklist against existing text and reports each violation with its rule number, the offending text, and a compliant rewrite. Rule numbers are cited only from the bundled ste-rules.md reference.

Does ASD-STE100 allow contractions and semicolons?

No. Rule 4.2 bans contractions, so write expanded forms like do not and it is. Rule 8.1 bans the semicolon, so split the thought into two sentences. Em dashes are also banned in this skill's resolutions.

Why does technical documentation sound like AI wrote it?

AI drafts repeat recognizable tropes: bold-first bullets, negative parallelism, fractal summaries, and filler like leverage and seamlessly. The bundled tropes.md catalogs these patterns so they can be found and rewritten as plain factual statements.