Borrowing it
Nothing to install: this file belongs to raydeStar/sir-thaddeus. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.
curl -O https://raw.githubusercontent.com/raydeStar/sir-thaddeus/master/.github/instructions/documentation-standards.instructions.mdgit clone --depth 1 https://github.com/raydeStar/sir-thaddeusWrote 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.
[](https://agentmods.dev/instructions/raydestar/sir-thaddeus/documentation-standards)<a href="https://agentmods.dev/instructions/raydestar/sir-thaddeus/documentation-standards"><img src="https://agentmods.dev/badge/instructions/raydestar/sir-thaddeus/documentation-standards/github.svg" alt="Measured on agentmods" height="20"></a>Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.
<a href="https://agentmods.dev/instructions/raydestar/sir-thaddeus/documentation-standards"><img src="https://agentmods.dev/badge/instructions/raydestar/sir-thaddeus/documentation-standards.svg" alt="Reviewed on agentmods" width="80" height="20"></a>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.
| Model | Per session | Once invoked |
|---|---|---|
| Fable 5.1 | $0.00421 | $0.00421 |
| Opus 5.5 | $0.00168 | $0.00168 |
| Sonnet 5.5 | $0.00084 | $0.00084 |
| Haiku 4.5 | $0.00042 | $0.00042 |
Grade A, and why
Documentation Writing 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 2mo 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.
What it actually says
Documentation Writing Standards
These rules apply to every agent editing user-facing documentation in this repository — not just the readme-specialist. They ensure a consistent voice, accurate claims, and a trustworthy first impression.
Voice and Tone
- Write clearly and simply. Prefer short paragraphs.
- Use a calm, confident tone — not breathless, not timid.
- Favor concrete language over abstractions.
- Avoid hype-heavy startup language and pitch-deck phrasing.
Accuracy
- Match the repo's actual capabilities. Do not claim unverified features.
- Preserve accurate links, commands, filenames, and doc references.
- If a claim cannot be verified from the codebase, soften the wording or flag it.
Platform Claims
- Verified support → "runs on."
- Intended but untested → "designed for" or "built for."
- Single-platform today → state that plainly.
Structure
- Keep the top of any README sparse and scannable.
- Explain what the product is in plain language before architecture.
- Put advanced technical material below the fold (use
<details>where appropriate). - Quick Start sections: 5 steps max, practical, no preamble.
Privacy and Trust Language
Sir Thaddeus is a local-first AI copilot. Its positioning centers on user control, explicit permissions, visible actions, and privacy. When editing docs:
- Make privacy and control easy to understand.
- Do not overstate security or privacy guarantees.
- Prefer honest, specific language over impressive-sounding generalities.
Priority Order
When multiple improvements compete, choose in this order:
- Accuracy
- Clarity
- First-time user comprehension
- Trustworthiness
- Brevity
- Elegance
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.
- 2mo ago First seen · 58 lines · 421 tokens per session scan A fab2540a249d
Documentation Writing Standards is an instructions file published in the GitHub repository raydeStar/sir-thaddeus (15 stars, last pushed 3d ago), licensed Apache-2.0. It adds 421 tokens to every session, about $0.0017 per session on Opus 5.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-08-30.
Other instructions, from other repositories
vscode buildNext.instructions.md
Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).
next.js AGENTS.md
AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.
vscode oss-third-party-notices.instructions.md
Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).
langchain AGENTS.md
AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.
vscode copilot-instructions.md
Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).
deepseek-harness AGENTS.md
AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.