Hads logo

Hads

CommunityPopular
wshobson
hads

Use when writing technical documentation that needs to be readable by both humans and AI models, converting existing docs to HADS format, validating a HADS document, or optimizing documentation for token-efficient AI consumption.

Overview

Publisherwshobson
Repositoryagents
Skill namehads
Stars
40.1K
Forks
4.3K
Bundled files
Instructions only
LicenseMIT
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • Self-contained

    Everything the model needs lives in the instructions — no extra files to sync.

  • Open source

    Published by wshobson on GitHub. Read the source before you install it.

Installation

Install the Hads AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
    https://github.com/wshobson/agents/tree/main/plugins/documentation-standards/skills/hads
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/wshobson/agents.git /tmp/agents
mkdir -p .claude/skills
cp -r /tmp/agents/plugins/documentation-standards/skills/hads .claude/skills/hads
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Hads in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Hads on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Hads is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

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 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 claims

Manifest minimum:

markdown
## AI READING INSTRUCTION
Read `[SPEC]` and `[BUG]` blocks for authoritative facts.
Read `[NOTE]` only if additional context is needed.
`[?]` blocks are unverified.

Frequently asked questions

What does the Hads AI skill do?

Use when writing technical documentation that needs to be readable by both humans and AI models, converting existing docs to HADS format, validating a HADS document, or optimizing documentation for token-efficient AI consumption.

Why use Hads on TypingMind?

Because you install it once and use it with any model. Hads is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Hads in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/wshobson/agents/tree/main/plugins/documentation-standards/skills/hads. TypingMind reads its SKILL.md and installs it as a skill you can enable per chat.

Which AI models can use Hads?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Hads?

As many as you like. As long as a model supports skills, you can use Hads with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Hads AI skill free?

Yes. It is published on GitHub by wshobson under the MIT license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇