本文へ移動
cccskills
無料GitHub で公開

technical-writer

Standard operating procedure for producing a documentation page end to end — gather source material, classify, draft against the measured corpus profile, then run the reader-level and humanizer passes and both gates. Use for any page on a documentation surface, or when rewriting a page that reads as machine-written. Orchestrates technical-writing, reader-level and humanizer in a fixed order.

インストール方法を見る

含まれるファイル(1)

  • SKILL.md6.7 KB

SKILL.md(原文)

インストールする前に、エージェントに与えられる指示の中身を確認できます。

This skill is the pipeline. technical-writing carries the craft rules and the measured targets; this skill says what order to do things in, what to gather first, and what must pass before a page is done.

Two failure modes it exists to prevent:

  1. Writing before knowing. A page drafted from the model's impression of a system is fluent and unfalsifiable. It reads as generated because it is describing a guess. Step 1 is not optional.
  2. Passing the checks in the wrong order. Simplifying after de-slopping reintroduces phrasing that the de-slop pass already cleaned, so the pass has to run twice and the second run flattens the prose.

Step 1 — Prepare context

Nothing is drafted until this is done. Produce a source table before writing a sentence.

  1. Read the implementation, not the description of it. For each claim the page will make, open the file that makes it true — the hook script, the config key, the CLI parser, the schema. Record path:line.
  2. Run the thing where running it is cheap. A flag table copied from a parser is right; a flag table recalled is not. Capture real output for the examples.
  3. Reconcile against the governing docs. Where this repository has a constitution, a genesis spec, or a manifest, the page must not contradict it. Note the Article or section each claim answers to.
  4. Check third-party APIs against current documentation before describing them (the declared documentation provider, official docs, or a pinned local cache). Never from recall.
  5. List what you could not verify. Anything left unverified is cut from the draft or written as an explicit open question. It is never softened into a vague sentence.

Output of this step is a working note: claim → source → verified date. Every factual sentence in the finished page traces back to a row in it.

If the source material is thin, the page is thin. Do not pad it with description. A short page that is entirely true is the correct deliverable.


Step 2 — Classify and shape

Pick exactly one Diátaxis type: reference, explanation, tutorial, or howto. This decides the numeric targets, the heading grammar, the person and the passive rate. See technical-writing Step 1.

Then sketch the section list before prose. Headings are noun phrases for reference and explanation; gerunds are correct for roughly a third of tutorial and how-to headings. Corpus mean heading length is 2.7 words.

Check the section count against the corpus: reference runs about 1,160 words per section, explanation 445, tutorial 225, how-to 201. A page with two enormous sections is under-structured.


Step 3 — Draft

Skill(technical-writing) — the craft rules and the measured profile.

Draft from the Step 1 source table only. While drafting, hold the four range moves in mind, because they are the ones that cannot be added by a later pass without rewriting:

  • Vary the paragraph opening move. Assertion should be about two thirds, not all of them.
  • Let roughly one sentence in nine run past 30 words, and put a short one after it.
  • Use can, may, must, will, should — about 20 per 1000 words.
  • Use the passive where the actor is irrelevant. Reference prose is around 36% passive.

Name real identifiers, enumerate real options, and show real output. Density of evidence is what separates a technical writer's page from a plausible one.


Step 4 — Reader level

node .claude/skills/reader-level/score.mjs --target 11 <file>     # reference, explanation
node .claude/skills/reader-level/score.mjs --target 10 <file>     # tutorial, how-to

Skill(reader-level) for the rewriting moves when it fails.

Use these targets, not the skill's default of 9. reader-level is a ceiling — it catches prose pitched above the reader. technical-writing sets the floor. Professional documentation measures at grade 10.7, so a target of 9 drives the page below the corpus band and strips the qualifying clauses that carry the meaning. Run together at target 11, the two gates bracket the page into the range real documentation occupies.

The other three reader-level limits (hard words, clause load, jargon load) stay at their defaults. They do not conflict with the corpus profile: the corpus sits at roughly 0.36 subordinate clauses and 0.6 identifiers per sentence, inside both limits.


Step 5 — Humanizer

Skill(humanizer) on the full draft. Always. Use its output.

Then re-check that its edits did not flatten the page: humanizer removes patterns, and removal moves several axes downward at once. Step 6 catches this.


Step 6 — Gates

Both must pass, in this order.

node .claude/skills/technical-writing/measure.mjs --type <type> <file>
node .claude/skills/reader-level/score.mjs --target <11|10> <file>

The first is the binding one. Threshold 4.5; the corpus median is 0.14. If it fails, read the named axes — each finding says which direction the page is wrong in and why that direction reads as machine-written — and return to Step 3. Do not tune sentences one at a time to move the number; fix the underlying habit the axis is reporting.

If a fix at Step 3 depends on a fact you do not have, go back to Step 1. A page that cannot pass without inventing something is a page missing source material.


Step 7 — Read it

The gates cannot see these. Run them by hand before declaring done.

  • Paragraph-reshuffle. Swap two body paragraphs. If nothing breaks, the section is a list wearing prose.
  • Treadmill. Per paragraph, ask what is new. Cut what is not.
  • Headings alone. Read them in order. They should read as a table of contents, not a series of claims.
  • Trace three claims. Pick three factual sentences at random and find their row in the Step 1 table. A miss means the page invented something, and the whole page needs re-checking.
  • Type leakage. Instruction on a reference page, explanation inside a tutorial — move it and link.

Receipt

Close with:

FieldValue
Page typeone of the four
Sources verifiedcount, and anything left unverified
measure.mjsscore before → after (threshold 4.5)
reader-levelgrade before → after (target 11 or 10)
Axes movedthe ones that were out of band and now are not

A receipt that cannot honestly be written means the page is not done.

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

同じリポジトリのスキル

概要と使いどころ

archive

無料

Phase 10.5 — move the slug's workflow artifacts (intake, scout, research, spec, approvals, swarm state, security reports, rendered diagrams) to docs/archive/<YYYY-MM-DD>/<slug>/. Runs before /commit so the committed tree is clean of work-in-flight files. workflow.json stays live and gets archived as the first step of /commit.

日本語の概要は準備中です。原文の説明を表示しています。

friedbotstudio/baseline142026年9月9日 更新

Drift check between the baseline implementation on disk and the claims in `docs/init/seed.md` + cross-references in CLAUDE.md, README.md, and the rendered docs site. Verifies hook/agent/skill/command names + counts, settings.json wiring, project.json key presence, .mcp.json servers, vendored license files, and helper script presence. Exit 0 PASS / 1 FAIL — suitable for CI. Read-only; safe to invoke any time.

日本語の概要は準備中です。原文の説明を表示しています。

friedbotstudio/baseline142026年9月9日 更新

PM-mode brainstorm helper. Captures the requirement via Socratic dialogue before any entry phase (`/intake`, `/spec`, `/tdd`) drafts its artifact. Stage 0 skip-check, Stage 1 gap-analysis, Stage 2 probe-loop, Stage 3 confirm-and-persist. Output lives at `docs/brief/<slug>.md`. Never proposes solutions — Stage 2 dialogue discipline is structurally enforced via `discipline.mjs`.

日本語の概要は準備中です。原文の説明を表示しています。

friedbotstudio/baseline142026年9月9日 更新

brd

無料

Draft a Business Requirements Document (BRD) for cross-functional or stakeholder-heavy work that needs more structure than an intake. Use after `/intake` when the request spans multiple systems/teams, carries regulatory weight, or needs formal sign-off. Output lives at `docs/brd/<slug>.md`.

日本語の概要は準備中です。原文の説明を表示しています。

friedbotstudio/baseline142026年9月9日 更新

chore

無料

Workflow track for tasks that need no TDD — documentation edits, governance count bumps, vendored-skill content updates, configuration tweaks, formatting, typo fixes, dependency bumps where no project code changes. Skips `/scenario` and `/implement` (no failing test to drive) and runs the work directly. `archive`, `memory-sync`, `/grant-commit`, and `/commit` remain mandatory. `verify`, `simplify`, `integrate`, and `document` are conditional — required when the diff hits one of the listed triggers, optional otherwise. `verify` is skipped only when the diff is pure-docs/prose AND `project.json → test.kind` is `behavior` (absent/invalid `test.kind` → `structural` → verify runs). Chore is a stripped-down pipeline, not a bypass; never silently skip a conditional phase whose triggers apply.

日本語の概要は準備中です。原文の説明を表示しています。

friedbotstudio/baseline142026年9月9日 更新

Analyze a codebase and recommend Claude Code automations (hooks, subagents, skills, plugins, MCP servers). Use when user asks for automation recommendations, wants to optimize their Claude Code setup, mentions improving Claude Code workflows, asks how to first set up Claude Code for a project, or wants to know what Claude Code features they should use.

日本語の概要は準備中です。原文の説明を表示しています。

friedbotstudio/baseline142026年9月9日 更新

friedbotstudio のスキルをすべて見る

このスキルの問題を報告する