writing-ai-docs

What problem does it solve?

This Skill ensures AI-ready documentation by enforcing frontmatter and structured content so AI tools can parse, retrieve, and use documentation reliably.

Core Features & Use Cases

• Frontmatter validation: ensures required fields (title, description, type, created, lastUpdated) and optional discovery fields are present.
• Structural governance: enforces one H1, strict heading hierarchy, self-contained sections, and explicit language for AI chunking.
• Use cases include generating AI-ready docs from templates, validating existing markdown files, and guiding authors during content creation.

Quick Start

Create AI-ready docs by invoking the included scripts to scaffold, validate, and lint your Markdown files. Examples: create new docs from templates, run quality checks, and fix linting issues.