reem-sab/tech-writer-prompts

An open-source, tested prompt library for technical writers. Prompts are documentation. Documentation gets tested.

This repository also configures its own agents. See what tech-writer-prompts tells them →

4Stars on the repository
17Mods indexed here, across every type
11d agoLast push, which is what freshness is scored on
MITLicence, which decides whether bodies are shown

tech-writer-prompts

01

reem-sab/tech-writer-prompts

Skill Claude CodeCodex

A tested library of 15 prompts for technical-writing tasks: auditing docs pages, walking quickstarts as a hostile first-time user, building error catalogs, drafting API references from OpenAPI specs, writing release notes, extracting glossaries, style-checking, rating pages for agent readers, Diataxis classification…

not rated 4 11d ago A 128 tokens original MIT

agent-readiness

02

reem-sab/tech-writer-prompts

Skill Claude CodeCodex

Rates a documentation page for machine readers, flagging ambiguous pronouns, steps that depend on unstated context, missing structure, and claims an agent would execute wrongly, then returns an overall score with specific fixes. Use this skill when the task is: Rates a page for how safely an autonomous agent could act…

not rated 4 11d ago A 137 tokens original MIT

api-ref-skeleton

03

reem-sab/tech-writer-prompts

Skill Claude CodeCodex

Turns an OpenAPI spec into a reference page draft with per-endpoint descriptions, parameter tables, and request and response examples, adding explicit TODO markers wherever the spec does not say enough to write from. Use this skill when the task is: Turns an OpenAPI spec into a reference page draft, one section per…

not rated 4 11d ago A 113 tokens original MIT

audit-page

04

reem-sab/tech-writer-prompts

Skill Claude CodeCodex

Reviews a documentation page against a 10-point rubric covering accuracy signals, completeness, scannability, and prerequisite gaps. Outputs a scored table plus a prioritized fix list. Use this skill when the task is: Reviews a single documentation page against a fixed 10-point rubric that covers prerequisite…

not rated 4 11d ago A 123 tokens original MIT

diataxis-classify

05

reem-sab/tech-writer-prompts

Skill Claude CodeCodex

Identifies whether a page is trying to be a tutorial, how-to guide, reference, or explanation (per the Diataxis framework), flags where it mixes modes, and proposes how to split it into one page per mode. Use this skill when the task is: Classifies a page against the four Diataxis modes, which are tutorial, how-to…

not rated 4 11d ago A 125 tokens original MIT

doc-from-transcript

06

reem-sab/tech-writer-prompts

Skill Claude CodeCodex

Drafts documentation updates from an engineering meeting transcript or Slack thread, with a verify-against-source checklist attached to every factual claim so nothing informal ships as fact unreviewed. Use this skill when the task is: Drafts a documentation update from an engineering meeting transcript or Slack…

not rated 4 11d ago A 99 tokens original MIT

error-catalog

07

reem-sab/tech-writer-prompts

Skill Claude CodeCodex

Turns raw error codes and strings pulled from source into a troubleshooting table giving the cause, the fix, and how the reader got there for each one, plus a JSON version meant for agents to consume directly. Use this skill when the task is: Converts a raw list of error codes and strings, the kind pulled straight…

not rated 4 11d ago A 113 tokens original MIT

freshness-triage

08

reem-sab/tech-writer-prompts

Skill Claude CodeCodex

Cross-references a documentation page against its git log and the source files it documents to rank which claims are most likely stale, with a specific check for each. Use this skill when the task is: Cross-references a documentation page against its git log and the current source it documents to rank which specific…

not rated 4 11d ago A 100 tokens original MIT

glossary-extract

09

reem-sab/tech-writer-prompts

Skill Claude CodeCodex

Scans a set of pages for domain-specific terms that are used but never defined anywhere in them, ranks them by frequency, and drafts a definition for each from context, to review before publishing. Use this skill when the task is: Scans a set of pages for domain-specific terms that are used repeatedly but never…

not rated 4 11d ago A 107 tokens original MIT

ia-review

10

reem-sab/tech-writer-prompts

Skill Claude CodeCodex

Reviews a sidebar/nav structure for orphaned pages, duplicate scopes, and missing landing pages, and proposes a reorganization with rationale for each change. Use this skill when the task is: Reviews the sidebar or nav outline of a docs site for orphaned pages, duplicate topic scopes, and sections missing a landing…

not rated 4 11d ago A 80 tokens original MIT

localization-prep

11

reem-sab/tech-writer-prompts

Skill Claude CodeCodex

Flags idioms, cultural references, ambiguous antecedents, and merged sentences in a draft that will break or distort in translation, and suggests a neutral rewrite for each. Use this skill when the task is: Flags idioms, cultural references, ambiguous antecedents, and merged sentences that tend to break or distort in…

not rated 4 11d ago A 95 tokens original MIT

reem-sab/tech-writer-prompts

Skill Claude CodeCodex

Walks a quickstart as a first-time user on a clean machine, interpreting every instruction as literally and narrowly as possible. Flags every unstated prerequisite, ambiguous step, and missing verification checkpoint. Use this skill when the task is: Walks a quickstart the way a real first-time user does: with zero…

not rated 4 11d ago A 115 tokens original MIT

release-notes

13

reem-sab/tech-writer-prompts

Skill Claude CodeCodex

Turns a commit list or internal changelog into customer-facing release notes grouped by impact (breaking, new, and fixed), with a one-line summary a support team could paste straight into a ticket. Use this skill when the task is: Turns a raw commit list or internal changelog into customer-facing release notes grouped…

not rated 4 11d ago A 91 tokens original MIT

screenshot-to-steps

14

reem-sab/tech-writer-prompts

Skill Claude CodeCodex

Turns a screen recording description or a set of numbered screenshot descriptions into a written procedure phrased by what UI elements are named, not where they sit or what they look like, so it survives a redesign. Use this skill when the task is: Turns a numbered sequence of screenshot or screen-recording frame…

not rated 4 11d ago A 103 tokens original MIT

skill-file-draft

15

reem-sab/tech-writer-prompts

Skill Claude CodeCodex

Turns a docs section describing a capability or workflow into a SKILL.md draft in the Agent Skills format, with two starter eval cases so the skill ships testable from day one. Use this skill when the task is: Turns a docs section describing a capability or workflow into a SKILL.md draft in the Agent Skills format.…

not rated 4 11d ago A 112 tokens original MIT

style-check

16

reem-sab/tech-writer-prompts

Skill Claude CodeCodex

Applies a style guide to a draft without flattening the author's voice. Outputs a diff-style list of specific violations with minimal targeted fixes -- never a full rewrite. Use this skill when the task is: Checks a draft against a style guide and reports violations as a numbered, diff-style list, giving the quoted…

not rated 4 11d ago A 110 tokens original MIT

At most 3 mods per repository are shown here, and a mod shipped inside a plugin is left to that plugin's page — the rest are on their repository pages: