
Hads
- 4.3k installs
- 38.3k repo stars
- Updated July 22, 2026
- wshobson/agents
HADS is a Markdown convention with four block types ([SPEC], [NOTE], [BUG], [?]) that optimizes technical documentation for both human and AI consumption. Requires H1 title, version, and AI manifest.
About
HADS (Human-AI Document Standard) is a Markdown convention for technical documentation that separates authoritative facts, context, and known issues into four block types: [SPEC], [NOTE], [BUG], and [?]. Developers use it when writing docs that AI models will read before humans, converting existing documentation, validating HADS compliance, or optimizing for token-efficient AI consumption. The format requires an H1 title, version declaration, and AI reading manifest. Key workflows include generating new HADS documents with terse spec blocks and narrative notes, converting existing READMEs into structured HADS format, validating document structure, and summarizing docs by reading only spec and bug blocks. No tooling required - standard Markdown files only. Four block types ([SPEC], [NOTE], [BUG], [?]) explicitly signal content type to AI models AI manifest required before first content section - tells models what to read and skip Terse [SPEC] blocks use bullets, tables, code instead of prose for token efficiency [BUG] blocks require symptom + cause + fix - surfaces hard-won knowledge Standard .md file extension with no custom tooling or
- Four block types ([SPEC], [NOTE], [BUG], [?]) explicitly signal content type to AI models
- AI manifest required before first content section - tells models what to read and skip
- Terse [SPEC] blocks use bullets, tables, code instead of prose for token efficiency
- [BUG] blocks require symptom + cause + fix - surfaces hard-won knowledge
- Standard .md file extension with no custom tooling or dependencies required
Hads by the numbers
- 4,257 all-time installs (skills.sh)
- +159 installs in the week ending Jul 28, 2026 (Skillselion tracking)
- Ranked #90 of 1,901 Documentation skills by installs in the Skillselion catalog
- Security screen: LOW risk (skills.sh audit)
- Data as of Jul 28, 2026 (Skillselion catalog sync)
hads capabilities & compatibility
0
- Capabilities
- generate new hads documents from specifications · convert existing markdown/readme to hads format · validate hads document structure and block forma · summarize hads documents by reading [spec] and [ · optimize technical documentation for token effic · extract facts into [spec], context into [note],
- Use cases
- documentation · api development · refactoring
- Platforms
- macOS · Windows · Linux · WSL
- Runs
- Runs locally
- Pricing
- Free
What hads says it does
HADS exists because AI models increasingly read documentation before humans do. The format optimizes for this reality without sacrificing human readability.
npx skills add https://github.com/wshobson/agents --skill hadsAdd your badge
Show developers this skill is listed on Skillselion. Paste this into your README.
| Installs | 4.3k |
|---|---|
| repo stars | ★ 38.3k |
| Security audit | 3 / 3 scanners passed |
| Last updated | July 22, 2026 |
| Repository | wshobson/agents ↗ |
What it does
Write and validate technical documentation optimized for both human readability and AI model consumption using structured Markdown blocks.
Who is it for?
Writing technical documentation for projects using AI agents, converting READMEs to structured formats, documenting APIs and hard-won failure modes, optimizing docs for LLM consumption.
Skip if: Marketing copy, user-facing guides without technical depth, real-time updating systems, or documentation that does not need AI model consumption.
When should I use this skill?
Writing new technical docs, converting existing README/Wiki to structured format, validating documentation quality, optimizing documentation token usage for AI.
What you get
Generate valid HADS documents, convert existing docs to HADS format, validate HADS compliance, and produce token-efficient AI-readable technical specifications.
- HADS 1.0.0 Markdown files
- Validation report
- Converted legacy docs
By the numbers
- Four block types: [SPEC], [NOTE], [BUG], [?]
- Required version in first 20 lines of document
- H1 title + AI manifest required before first content section
Files
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]
# 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 block tags bold:
**[SPEC]**not[SPEC]not [SPEC] [BUG]blocks contain at minimum symptom + fix
Validator: (planned — not yet included in this release)
---
7. EXAMPLE INTERACTIONS
[SPEC]
User: "Write HADS documentation for this REST API" → Generate full HADS document: header, manifest, sections with [SPEC]/[NOTE]/[BUG] blocks
User: "Convert this README to HADS format" → Restructure existing content into HADS blocks, preserve all facts, add manifest
User: "Is this document valid HADS?" → Check: H1 title, version, manifest, block tag formatting, BUG block completeness
User: "Summarize this HADS document" → Read only [SPEC] and [BUG] blocks, return structured summary
User: "What does this API do?" (HADS doc provided) → Read manifest, read [SPEC] blocks in relevant sections, answer directly
---
8. DESIGN INTENT
[NOTE] HADS exists because AI models increasingly read documentation before humans do. The format optimizes for this reality without sacrificing human readability.
Key insight: the AI manifest is the core innovation. It lets even small (7B) models know what to read and what to skip — without requiring them to reason about document structure. Explicit is better than implicit for model consumption.
When generating HADS, think of [SPEC] as the API surface and [NOTE] as the comments. [BUG] blocks are the most valuable content — they represent hard-won knowledge that saves others from hitting the same wall.
---
9. QUICK REFERENCE
[SPEC]
Tag | Bold format | Reader | Required content
----------|----------------|---------|------------------
[SPEC] | **[SPEC]** | AI | Facts, terse
[NOTE] | **[NOTE]** | Human | Context, narrative
[BUG] | **[BUG] ...** | Both | Symptom + fix
[?] | **[?]** | Both | Unverified claimsManifest minimum:
## AI READING INSTRUCTION
Read `[SPEC]` and `[BUG]` blocks for authoritative facts.
Read `[NOTE]` only if additional context is needed.
`[?]` blocks are unverified.Related skills
How it compares
Similar to AsciiDoc, reStructuredText, or Sphinx for documentation structure, but HADS is simpler Markdown-based and explicitly optimized for AI model consumption via manifest and block types.
FAQ
What are the four block types in HADS?
[SPEC] for authoritative facts (terse), [NOTE] for context/narrative (humans read if needed), [BUG] for verified failures with fixes, [?] for unverified claims.
Do I need special tooling to write HADS documents?
No. HADS is standard Markdown (file extension .md) with no tooling required. Use any text editor.
What makes HADS different from regular Markdown?
HADS adds an AI reading manifest and explicit block tags ([SPEC], [NOTE], [BUG], [?]) that signal content type. This lets AI models know what to read for ground truth versus context.
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.