docs-standards

docs-standards is a skill for Claude Code, Codex from github/gh-aw. It costs 13 tokens per session (530 once invoked), scanned A, original, MIT.

A documentation style guide combining Microsoft writing rules with conventions for Squad documentation. It covers headings, voice, structure, formatting, and keeping tests aligned with documentation changes.

In plain words
What is it for?
Use it when writing or reviewing feature pages, prompts, warnings, cross-references, and documentation-related test updates.
Why use it?
It removes inconsistency from technical docs and makes pages easier to scan, understand, and maintain.

Skill for Claude CodeCodex

About the project

GitHub Agentic Workflows is a GitHub CLI extension that lets developers define AI-assisted repository automation in Markdown and run it through GitHub Actions. It is intended for tasks requiring interpretation or reasoning, such as issue triage, pull-request review, CI investigation, documentation maintenance, and dependency analysis. The catalogue entries provide skills and agents for working with these workflows.

github/gh-aw · 5,104 stars · on GitHub

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/github/gh-aw/docs-standards
Any agent
npx skills add github/gh-aw --skill docs-standards
Clone the repo
git clone --depth 1 https://github.com/github/gh-aw

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for docs-standards

README.md
[![agentmods](https://agentmods.dev/badge/skills/github/gh-aw/docs-standards.svg)](https://agentmods.dev/skills/github/gh-aw/docs-standards)
Your own site
<a href="https://agentmods.dev/skills/github/gh-aw/docs-standards"><img src="https://agentmods.dev/badge/skills/github/gh-aw/docs-standards.svg" alt="Measured on agentmods" height="20"></a>
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 original No closer match found 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 yesterday 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 yesterday.

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

Copies of this mod

8 near-identical copies found in the catalogue:

.squad/templates/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. yesterday 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 github/gh-aw (5,104 stars, last pushed today), 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. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-03.

Related

Other skills, from other repositories

c-github

Interact with GitHub using the gh CLI and jq. Manage PRs, issues, repositories, and Actions workflows. Make raw API calls with gh api for anything not covered by built-in commands.

daxaur/openpaw · 48 tokens

watch-pr

Watch a GitHub pull request for CI status, reviews, comments, merge conflicts, and terminal states using the gh-watch extension. Use when the user wants to monitor a PR, wait for CI, or track PR progress.

justincampbell/gh-watch · 48 tokens

watch-tag

Watch a GitHub repository for new tags using the gh-watch extension. Use when the user wants to be notified when a tag is created, when a release is cut, or when a tag that includes a specific commit appears (e.g. "tell me when my merge ships in a release").

justincampbell/gh-watch · 62 tokens

watch-branch

Watch a GitHub branch for new commits using the gh-watch extension. Use when the user wants to be notified when new commits are pushed to a branch, monitor main for merges, or track branch activity.

justincampbell/gh-watch · 45 tokens

watch-commit

Watch a GitHub commit for CI status changes using the gh-watch extension. Use when the user wants to monitor a commit's CI checks, wait for a build to finish, or track CI progress on a specific SHA.

justincampbell/gh-watch · 48 tokens

update-architecture-docs

Generate or update the architecture documentation in docs/content/architecture/. Use on "update architecture docs", "generate architecture documentation", "regenerate architecture docs", or after any structural change to the codebase.

AlexSkrypnyk/scaffold · 46 tokens