skills.rest
SanketAdlak
SanketAdlakCOMMUNITY
Explore all skills by this author →
Website𝕏@devsanket14GitHub

hads

Generates, converts, and validates Markdown documentation in the HADS format for AI-readable technical docs.

Updated Apr 23, 2026
Search Tags:#documentation#markdown#validation#technical writing#format conversion#hads#ai-readable
One-click install
npx skills add https://github.com/SanketAdlak/PDMProjectDesign --skill hads-sanketadlak
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: hads
Source: https://github.com/SanketAdlak/PDMProjectDesign/tree/main/.agents/skills/hads
Command: npx skills add https://github.com/SanketAdlak/PDMProjectDesign --skill hads-sanketadlak

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Technical documentation is often written only for humans, forcing AI models to parse long narrative prose and guess which facts are authoritative. HADS solves this by structuring Markdown docs into typed blocks ([SPEC], [NOTE], [BUG], [?]) with an AI reading manifest, so both humans and AI models consume the same document efficiently. ## Core Features & Use Cases - HADS Generation: Write new documentation with the required header, version declaration, AI manifest, and typed content blocks. - Format Conversion: Restructure existing READMEs or docs into HADS by extracting facts into [SPEC], moving narrative to [NOTE], and surfacing known issues as [BUG]. - Validation: Check documents against HADS rules such as H1 title, version in the first 20 lines, manifest placement, bold block tags, and complete BUG blocks. - Use Case: A team maintaining an API reference converts it to HADS so that AI coding assistants read only the [SPEC] and [BUG] blocks, reducing token usage and preventing hallucinated answers. ## Quick Start Ask the AI to convert your existing README or API documentation into HADS format with an AI reading manifest and typed content blocks.

Frequently Asked Questions about hads

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write documentation that AI models can read efficiently?▼

Use the HADS format: add an AI reading manifest near the top, then organize facts into bold typed blocks like **[SPEC]** for authoritative facts and **[BUG]** for known issues. AI models read the manifest first and prioritize [SPEC] and [BUG] blocks, skipping narrative [NOTE] content.

How to convert an existing README to HADS format?▼

Extract factual statements into [SPEC] blocks as bullets, tables, or code, move narrative and history into [NOTE] blocks, and surface known issues as [BUG] blocks with symptom, cause, and fix. Add a version header and AI manifest, and avoid duplicating content between block types.

What makes a HADS document valid?▼

A valid HADS document needs an H1 title, a **Version X.Y.Z** declaration within the first 20 lines, an AI manifest before the first content section, and bold block tags like **[SPEC]**. [BUG] blocks must contain at minimum a symptom and a fix.

Does HADS require special tooling or file formats?▼

No. HADS documents are standard Markdown files with a .md extension and require no tooling. The format relies only on conventions: bold block tags, a version header, and an AI reading instruction section.

When should I use [NOTE] versus [SPEC] blocks?▼

Use [SPEC] for authoritative facts written tersely as bullets, tables, or code, with at most two sentences of prose. Use [NOTE] for human context, history, examples, and rationale that AI readers may skip when [SPEC] is sufficient.

Related Skills

Explore More Content & Communication Skills→
friedbotstudiofriedbotstudio
5

documentation

Drafts clear technical documentation from rough notes and source material.

Official
Intermediate
tigredonortetigredonorte

create-jira-wiki

Publish Jira task design documents to a wiki repository.

Community
Advanced
poindexter12poindexter12
7

doc-validator

Validate markdown documentation for completeness, accuracy, and consistency with the codebase.

Community
Advanced
armanzeroeightarmanzeroeight
29

api-docs-generator

Generate API documentation from code into HTML or JSON formats.

Community
Intermediate