docs-standards

A set of writing and formatting rules for Squad documentation, based on Microsoft's Style Guide. It covers headings, voice, tense, page structure, practical prompts, warnings, and related links.

In plain words
What is it for?
Use it when writing or reviewing feature pages, scenario pages, technical guidance, and other Squad documentation.
Why use it?
It keeps technical documents consistent and easier to scan, especially when many people contribute to the same project. It also reminds authors to keep tests in sync when documentation pages change.

Skill for Claude CodeCodex

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/alonf/specrew/docs-standards
Any agent
npx skills add alonf/specrew --skill docs-standards
Clone the repo
git clone --depth 1 https://github.com/alonf/specrew

Made for: Claude Code, Codex.

Per session 13 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 530 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin 100% copy Near-identical to another mod in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00013 $0.00530
Opus 5 $0.00006 $0.00265
Sonnet 5 $0.00003 $0.00106
Haiku 4.5 $0.00001 $0.00053

Measured 2d ago against content hash 49a99de5527e, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

docs-standards scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

Origin

This is a copy

100% identical to docs-standards — 0 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

.copilot/skills/docs-standards/SKILL.md · 72 lines

How it starts

The opening of the file, as written. The whole thing — 72 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Context

Squad documentation follows the Microsoft Style Guide with Squad-specific conventions. Consistency across docs builds trust and improves discoverability.

Patterns

Microsoft Style Guide Rules

  • Sentence-case headings: "Getting started" not "Getting Started"
  • Active voice: "Run the command" not "The command should be run"
  • Second person: "You can configure..." not "Users can configure..."
  • Present tense: "The system routes..." not "The system will route..."
  • No ampersands in prose: "and" not "&" (except in code, brand names, or UI elements)

Squad Formatting Patterns

  • Scannability first: Paragraphs for narrative (3-4 sentences max), bullets for scannable lists, tables for structured data
  • "Try this" prompts at top: Start feature/scenario pages with practical prompts users can copy
  • Experimental warnings: Features in preview get callout at top
  • Cross-references at bottom: Related pages linked after main content

Structure

  • Title (H1)Warning/calloutTry this codeOverviewHRContent (H2 sections)

Test Sync Rule

  • Always update test assertions: When adding docs pages to features/, scenarios/, guides/, update corresponding EXPECTED_* arrays in test/docs-build.test.ts in the same commit

Examples

Correct:

# Getting started with Squad

> ⚠️ **Experimental:** This feature is in preview.

Try this:
\`\`\`bash
squad init
\`\`\`

Squad helps you build AI teams...

---

## Install Squad

Run the following command...

Incorrect:

# Getting Started With Squad  // Title case

Squad is a tool which will help users... // Third person, future tense

You can install Squad with npm & configure it... // Ampersand in prose

Anti-Patterns

  • Title-casing headings because "it looks nicer"
  • Writing in passive voice or third person
  • Long paragraphs of dense text (breaks scannability)
  • Adding doc pages without updating test assertions
  • Using ampersands outside code blocks

Read the full file on GitHub · 72 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 72 lines · 13 tokens per session scan A 49a99de5527e

Subscribe to this mod's changes

docs-standards is a skill published in the GitHub repository alonf/specrew (54 stars, last pushed 3d ago), licensed MIT. It adds 13 tokens to every session and 530 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. It is 100% identical to docs-standards, differing in 0 lines, and is treated as a copy.

Related

Other skills, from other repositories

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

brainstorming

You MUST use this before any creative work - creating features, building components, adding functionality, or modifying behavior. Explores user intent, requirements and design before implementation.

obra/superpowers · 37 tokens

auto-perf-optimize

Run agent-driven VS Code performance or memory investigations. Use when asked to launch Code OSS, automate a VS Code scenario, run the Chat memory smoke runner, capture renderer heap snapshots, take workflow screenshots, compare run summaries, or drive a repeatable scenario before heap-snapshot analysis.

microsoft/vscode · 62 tokens

chat-perf

Run chat perf benchmarks and memory leak checks against the local dev build or any published VS Code version. Use when investigating chat rendering regressions, validating perf-sensitive changes to chat UI, or checking for memory leaks in the chat response pipeline.

microsoft/vscode · 51 tokens

chat-pet-sprite-creation

Use when creating or changing VS Code chat pet sprite art, sprite sheets, state animations, eye treatments, Stable/Insiders variants, or pet transitions under src/vs/workbench/contrib/chat/browser/widget/media/chatPet.

microsoft/vscode · 53 tokens

cpu-profile-analysis

Analyze V8/Chrome CPU profiles (.cpuprofile) and DevTools trace files (Trace-.json). Use when: profiling performance, investigating slow functions, comparing code paths, finding bottlenecks, analyzing timeToRequest, understanding call trees from sampling profiler data, analyzing layout/paint/rendering, investigating…

microsoft/vscode · 71 tokens