
Hads
Author or refactor technical docs so humans and models share one terse, token-efficient Markdown standard (HADS).
Install
npx skills add https://github.com/wshobson/agents --skill hadsWhat is this skill?
- HADS 1.0.0: four block types—SPEC (authoritative), NOTE (optional context), BUG (symptom/cause/fix), ? (unverified)
- Required document skeleton: H1 title, version line, AI manifest before first content section
- Validate existing Markdown for HADS compliance and convert legacy docs
- Plain .md files—no custom tooling required for authors
Adoption & trust: 2.9k installs on skills.sh; 36.5k GitHub stars; 3/3 security scanners passed (skills.sh audits).
Recommended Skills
Lark Doclarksuite/cli
Lark Wikilarksuite/cli
Opensource Guide Coachxixu-me/skills
Readme I18nxixu-me/skills
Doc Coauthoringanthropics/skills
Obsidian Markdownkepano/obsidian-skills
Journey fit
Primary fit
Canonical shelf is Build/docs where specs, runbooks, and agent context are written; the same format carries into ship and operate handoffs. Docs subphase covers structured technical writing that agents can reliably parse alongside human readers.
Common Questions / FAQ
Is Hads safe to install?
skills.sh reports 3 of 3 security scanners passed. Review the Security Audits panel on this page before installing in production.
SKILL.md
READMESKILL.md - Hads
# HADS Claude Skill **Version 1.0.0** · Human-AI Document Standard · 2026 · HADS 1.0.0 --- ## AI READING INSTRUCTION This skill teaches Claude how to read, generate, and validate HADS documents. Read all `[SPEC]` blocks before responding to any HADS-related request. Read `[NOTE]` blocks if you need context on intent or edge cases. --- ## 1. WHAT IS HADS **[SPEC]** - HADS = Human-AI Document Standard - Convention for Markdown technical documentation - Four block types: `**[SPEC]**`, `**[NOTE]**`, `**[BUG]**`, `**[?]**` - Every HADS document requires: H1 title, version declaration, AI manifest - AI manifest appears before first content section, tells AI what to read/skip - File extension: `.md` — standard Markdown, no tooling required --- ## 2. BLOCK TYPES **[SPEC]** ``` **[SPEC]** Authoritative fact. Terse. Bullet lists, tables, code. AI reads always. **[NOTE]** Human context, history, examples. AI may skip. **[BUG]** Verified failure + fix. Required fields: symptom, cause, fix. Always read. **[?]** Unverified / inferred. Lower confidence. Always flagged. ``` Block tag rules: - Bold, on its own line: `**[SPEC]**` - Content follows immediately (no blank line between tag and content) - Multiple blocks of different types allowed per section - Titled BUG blocks allowed: `**[BUG] Short description**` - No nesting of blocks inside blocks --- ## 3. REQUIRED DOCUMENT STRUCTURE **[SPEC]** ```markdown # Document Title **Version X.Y.Z** · Author · Date · [metadata] --- ## AI READING INSTRUCTION Read `[SPEC]` and `[BUG]` blocks for authoritative facts. Read `[NOTE]` only if additional context is needed. `[?]` blocks are unverified — treat with lower confidence. --- ## 1. First Section **[SPEC]** ... ``` Required elements in order: 1. H1 title 2. `**Version X.Y.Z**` in header (first 20 lines) 3. AI manifest section before first content section 4. Content sections (H2), subsections (H3) --- ## 4. HOW CLAUDE READS HADS **[SPEC]** When encountering a HADS document: 1. Find and read the AI manifest first 2. Read all `[SPEC]` blocks — these are ground truth 3. Read all `[BUG]` blocks — always, before generating any code or config 4. Read `[NOTE]` blocks only if `[SPEC]` is insufficient to answer the query 5. Treat `[?]` content as hypothesis — note uncertainty in response Token optimization: for large documents, scan section headings first, then read only `[SPEC]` and `[BUG]` blocks in relevant sections. --- ## 5. HOW CLAUDE GENERATES HADS **[SPEC]** When asked to write documentation in HADS format: 1. Start with header block (title, version, metadata) 2. Add AI manifest — always include, never skip 3. Organize content into numbered H2 sections 4. For each fact: write as `[SPEC]` — terse, bullet or table or code 5. For each "why" or context: write as `[NOTE]` 6. For each known failure mode with confirmed fix: write as `[BUG]` 7. For each unverified claim: write as `[?]` 8. End with changelog section Content rules for `[SPEC]`: - Prefer bullet lists over prose - Prefer tables for multi-field facts - Prefer code blocks for syntax, formats, examples - Maximum 2 sentences of prose — if more needed, move to `[NOTE]` Content rules for `[BUG]`: - Always include: symptom, cause, fix - Optional: affected versions, workaround - Title on same line: `**[BUG] Short description**` **[NOTE]** When converting existing documentation to HADS: extract facts into `[SPEC]`, move narrative and history to `[NOTE]`, surface all known issues as `[BUG]`. Do not duplicate content between block types. --- ## 6. VALIDATION RULES **[SPEC]** A valid HADS document must have: - H1 title - `**Version X.Y.Z**` in first 20 lines - AI manifest before first content section - All