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

docs-reviewer

Review a Box documentation draft in docs/user/ or docs/design/ for placement, structure, altitude, readability, terminology, and claim scope, and give a verdict (Ship it, Tighten, or Rethink). Use after docs-writer produces a draft, before a docs pull request, or when asked to "review this draft", "check my docs", or "is this page ready to ship". Read-only.

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

strands-agents/boxスター 475(GitHub 475 + cccskills 0)

実行スコア 未検証

インストール方法を見る

含まれるファイル(2)

  • SKILL.md5.3 KB
  • check-prose.sh1.7 KB

SKILL.md(原文)

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

Documentation reviewer

Scope. Whether a draft is in the right place, shaped around its subject, at the right altitude, easy to read, and consistent with the terminology lock, measured against voice-guide.md. You don't check that a claim is correct against the code and its tests. That's the docs-audit skill.

Readability and altitude come first. A page can pass every mechanical rule and still be a page nobody wants to read, and that's a fail.

Procedure

  1. Read the draft once straight through, as its reader would. Note where you had to reread.

  2. Run the mechanical check, and use its hits as input to dimension 4:

    .agents/skills/docs-reviewer/check-prose.sh <draft>
    
  3. Classify the content type from the directory and the structure.

  4. Score each dimension below as pass, warning, or fail.

  5. Give one verdict.

  6. Write the review in the output format.

Dimensions

1. Placement and shape

  • The page is in the right guide. A user page that argues a design, or a design page that's a list of options, is in the wrong guide.
  • The structure follows the subject. A page about several parts has one section per part, and no part is spread across sections. A page about one task follows the reader's order.
  • No section mixes content types. Conceptual background in a how-to guide is a finding.
  • No section exists only to fill a template slot.
  • The page doesn't do the job of decisions.md, terminology.md, or tenets.md.

2. Altitude

  • Each detail belongs to this page. Detail that belongs to a sibling topic (a wire protocol on a page about binaries, Seatbelt rules on a page about policy) is a finding, even when that page doesn't exist yet.
  • Length fits the subject. A draft that's much longer than the subject needs is a finding.

3. Readability

  • Read aloud, each sentence sounds like a person said it. Quote each one that doesn't, and give a plainer version.
  • Each section opens with what the reader needs first. A design section says what the thing is before what it guarantees.
  • A list isn't walked through twice.
  • Each term is introduced before its shorthand is used.

4. Constraints and terminology

  • The words not to use, em-dashes, emoji, padded triads, and negative parallelism. Apply the override table for the content type.
  • User guide: describe what is, and no "why" unless it changes the action.
  • Each word from the "do not use" column of docs/design/terminology.md is a finding. A term the lock doesn't have, or a lock term that the code calls something else, is a question for the user.

5. Claim scope

  • Each reason links its decision anchor the first time it comes up, and the decision is summarized, not copied. A reason with no link is a finding.
  • A claim stated more broadly than the mechanism it describes is a finding.
  • No test name, no source file, no issue or pull request number, no file.rs:LINE citation, and no link into .agents/drafts/ or .agents/explorations/.

6. Examples, diagrams, and standing alone

  • Each example is complete and realistic, one concept per block, with the output below the command.
  • Prose and code agree.
  • Each diagram shows the main path only, is Mermaid with every label quoted, and has no ASCII art.
  • The first paragraph says what the page covers. Prerequisites are stated, terms are defined or linked on first use, and no cross-reference carries the load.

Verdicts

Ship it. All dimensions pass, with one minor warning at most.

Tighten. Two or more warnings, or one fail that an edit in place fixes. Typical causes: a few sentences that don't read aloud, detail that belongs on another page, terminology slips, or a draft much longer than it needs to be. Give a fix for each finding, at its line.

Rethink. Two or more fails, or one structural fail: the wrong guide, a shape that spreads each part across sections, a page mostly at the wrong altitude, or prose that reads like a spec throughout. Give the diagnosis and the right approach.

If you can't decide between Tighten and Rethink, ask: can the writer fix this in place, or do they need to re-outline? In place is Tighten. Re-outline is Rethink.

Output format

## Review: <page title>

**Guide and type:** <user guide or design guide>, <type>
**Verdict:** Ship it | Tighten | Rethink

| Dimension | Score | Key finding |
|---|---|---|
| Placement and shape | ... | ... |
| Altitude | ... | ... |
| Readability | ... | ... |
| Constraints and terminology | ... | ... |
| Claim scope | ... | ... |
| Examples, diagrams, standing alone | ... | ... |

### Findings

1. <file>:<line>: <the finding>. Fix: <the fix>.

### What works

<Two or three things the draft does right.>

What this skill doesn't do

  • Edit the draft. The writer fixes it.
  • Check a claim against the code. That's docs-audit.
  • Commit, push, or approve a pull request.

レビュー

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

コメント

ログインなしで書き込めます。使ってみた感想、質問、動かなかった環境などを気軽にどうぞ。

まだコメントはありません。最初のコメントを書いてみませんか。

送信するとすぐに公開されます。メールアドレスや電話番号などの個人情報は書かないでください。URL は 2 つまでです。

0 / 1000 文字

このフォームは reCAPTCHA で保護されており、Google のプライバシーポリシーと利用規約が適用されます。

同じリポジトリのスキル

Author or edit a Strands Box policy (`policy.dw`) — turn an operator's natural-language allow/deny intent into a validated Dogwood policy over the box's fixed action vocabulary, including `when temporal { … }` history rules. Use when writing, editing, reviewing, or converting an intent into a box policy. This skill CREATES or EDITS a policy against the box's built-in schema — you never author a Dogwood schema, because the box ships a fixed one.

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

strands-agents/box4752026年10月26日 更新

Debug a CI failure on an OS you are not on (you are on Linux, it fails on macos-latest, or the reverse) without opening a pull request per attempt. Use when a test is green on your machine and red on a GitHub runner, or when you need to run one test or one shell probe on a runner and read the result fast. The core move is a dispatchable, scoped workflow on your own fork: pick one OS, skip lint, filter to one test, and for environment questions run a no-build probe that returns in seconds instead of a ten-minute build. Iterate by pushing to the fork branch and re-dispatching, never by editing a PR.

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

strands-agents/box4752026年10月26日 更新

Assess an existing Box documentation page (docs/user/, docs/design/, or a crate README.md) for accuracy against the code and its tests, placement, and voice, and recommend what to fix. Use before a rewrite, when a page may have drifted from the code, or when asked to "audit this page", "is this page still true", or "what is wrong with this doc".

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

strands-agents/box4752026年10月26日 更新

Find the gaps in the Box documentation and produce a prioritized backlog for docs/user/ and docs/design/. Use when planning documentation work, after a feature or a binary ships without a page, for a periodic health check of the docs, or when asked "what docs need writing", "plan the docs work", "prioritize the docs backlog", or "what should we document next".

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

strands-agents/box4752026年10月26日 更新

Draft or rewrite a Box documentation page in docs/user/ (tutorial, how-to, or reference for an operator) or docs/design/ (explanation for a security evaluator or a contributor), or a crate README.md that serves a consumer. Use when asked to write a doc, draft a page, rewrite a page that failed audit, document a feature or a component, or write an architecture or security page. Not for docs/design/decisions.md (use kd), local specs (use spec), or research notes (use explore).

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

strands-agents/box4752026年10月26日 更新

explore

無料

Launch a deep, multi-faceted investigation of a topic using parallel sub-agents. Each agent tackles a different angle simultaneously, and findings are synthesized into structured exploration documents.

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

strands-agents/box4752026年10月26日 更新

strands-agents のスキルをすべて見る

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