ai-doc-writing

Convert verbose documentation into AI-optimized structured YAML data.

1|Updated Oct 21, 2025
One-click install
npx skills add https://github.com/vinceh/recipe --skill ai-doc-writing
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ai-doc-writing
Source: https://github.com/vinceh/recipe/tree/main/.claude/skills/ai-doc-writing
Command: npx skills add https://github.com/vinceh/recipe --skill ai-doc-writing

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

Documentation produced for AI contexts often contains fluff, inconsistent structure, or missing essential details. This skill provides style principles for AI-context docs (completeness, efficiency, zero fluff), a fluff detector, and refactoring patterns to convert prose into structured data that is easy for AI to consume.

Core Features & Use Cases

  • Style principles: completeness, efficiency, zero fluff.
  • Fluff detector to identify meta-commentary, conversational language, and heading hierarchy violations.
  • Refactoring patterns to convert to YAML/code blocks and structured data.
  • Quick Start: apply AI-optimized documentation to API references, setup guides, or architecture docs.

Quick Start

Feed a Markdown document to the AI-Optimized Documentation flow and request a restructure into YAML blocks with concise, imperative steps.

Frequently Asked Questions about ai-doc-writing

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

FAQPage Schema
How do I convert documentation into AI-optimized structured format?

AI-optimized documentation converts verbose prose into structured data by enforcing strict heading hierarchy, replacing narrative text with YAML/code blocks, and removing meta-commentary. This produces clean, parseable content that AI systems consume efficiently without fluff or ambiguity.

What counts as fluff in documentation written for AI consumption?

Fluff includes meta-commentary, conversational language, inconsistent heading structure, and prose that could be replaced by imperative steps or structured data. The fluff detector identifies these patterns so you can refactor toward completeness and efficiency—the core principles for AI-context docs.

Can I apply AI-optimized documentation principles to API references and setup guides?

Yes. The Skill covers refactoring API references, setup guides, architecture references, workflow guides, and configuration specs. Feed Markdown documents to the workflow, request restructure into YAML blocks with concise imperative steps, and validate examples against the style guide.

What's the difference between documentation optimized for humans versus AI?

Human-focused docs prioritize narrative flow and explanation; AI-optimized docs prioritize structure, completeness, and zero fluff. AI-context documentation uses strict heading hierarchy, structured data blocks over prose, and removes conversational language so AI systems extract intent and requirements without parsing ambiguity.

How do I know if my documentation meets AI-optimized standards?

Check for three criteria: completeness (all essential details present), efficiency (no redundant or conversational text), and zero fluff (no meta-commentary or heading hierarchy violations). The Skill provides a fluff detector and style guide to validate that your refactored docs meet these standards.