Hads
Seth HobsonCommunityCreated by Niksa BarlovicDistributed by Seth Hobson
- Skill
- Guidelines
- Documents and content
- MIT
- No issues found
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
HADS (Human-AI Document Standard) is a convention for structuring technical documentation to improve how AI models process and retrieve information. By using specific block tags—SPEC, NOTE, BUG, and ?—the format separates authoritative facts from narrative context and known issues. It requires a consistent structure, including a version declaration and an AI manifest, which instructs models on how to prioritize different sections of the document.
What it does
- Defines a structured Markdown format using specific bolded block tags.
- Provides an AI manifest section to guide model reading behavior.
- Categorizes content into authoritative facts, human context, verified bugs, and unverified claims.
- Standardizes the inclusion of versioning and document metadata.
- Offers rules for converting existing documentation into the HADS format.
- Ensures BUG blocks contain essential symptom, cause, and fix information.
When to use it
- When creating new technical documentation intended for AI-assisted workflows.
- When converting existing READMEs or manuals to improve AI comprehension.
- When you need to ensure AI models prioritize factual data over narrative context.
- When documenting known issues and their resolutions for automated retrieval.
Advantages
- Improves AI accuracy by explicitly marking authoritative information.
- Reduces token consumption by allowing models to skip non-essential narrative blocks.
- Maintains human readability through standard Markdown conventions.
- Provides a clear, consistent structure for technical knowledge bases.
Usage examples
- “Write HADS documentation for this REST API.”
- Generates a structured document with a header, AI manifest, and content organized into SPEC, NOTE, and BUG blocks.
- “Convert this README to HADS format.”
- Restructures the existing text into the HADS block system, preserving facts while adding the required AI manifest.
- “Summarize this HADS document.”
- Reads only the SPEC and BUG blocks to provide a concise, fact-based summary of the document.
- “Is this document valid HADS?”
- Checks for the presence of an H1 title, versioning, the AI manifest, and correct block tag formatting.
Install
Download the skill as a ZIP:
https://autogineer.com/agent-skills/wshobson/hads/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip hads.zip -d .agents/skills
Documentation by Niksa Barlovic
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:
H1 title
**Version X.Y.Z**in header (first 20 lines)AI manifest section before first content section
Content sections (H2), subsections (H3)
4. HOW CLAUDE READS HADS
[SPEC] When encountering a HADS document:
Find and read the AI manifest first
Read all
[SPEC]blocks — these are ground truthRead all
[BUG]blocks — always, before generating any code or configRead
[NOTE]blocks only if[SPEC]is insufficient to answer the queryTreat
[?]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:
Start with header block (title, version, metadata)
Add AI manifest — always include, never skip
Organize content into numbered H2 sections
For each fact: write as
[SPEC]— terse, bullet or table or codeFor each "why" or context: write as
[NOTE]For each known failure mode with confirmed fix: write as
[BUG]For each unverified claim: write as
[?]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 linesAI 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.Files
- ATTRIBUTION.mdAdded by AutoGineer961 B
- LICENSELicence file added by AutoGineer1.0 KiB
- SKILL.md6.0 KiB
LICENSE
MIT License Copyright (c) 2024 Seth Hobson Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Requirements and compatibility
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta
“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.
Security
No issues found by our static scan· No issues found
A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.
Attribution and licence
- Created by
- Niksa Barlovic
- Publisher
- Seth Hobson (Community)
- Distributed by
- Seth Hobson
- Source
- wshobson/agents · plugins/documentation-standards/skills/hads · commit 4bde316
- Licence
- MIT License (redistribution allowed)
- LICENSE (added by AutoGineer from LICENSE)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
AutoGineer is not affiliated with or endorsed by Niksa Barlovic or Seth Hobson.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download hads.zip