documentation-standards

Structure Markdown documentation for machine readability and Pandoc PDF conversion.

62|10|Updated Dec 4, 2025

Search Tags:#pdf #documentation #markdown #llm #pandoc #hub-and-spoke

One-click install

npx skills add https://github.com/terrylica/cc-skills --skill documentation-standards-terrylica

Or copy as Structured Prompt for Agent▼

Please help me install this Agent Skill.
Skill: documentation-standards
Source: https://github.com/terrylica/cc-skills/tree/main/plugins/doc-tools/skills/documentation-standards
Command: npx skills add https://github.com/terrylica/cc-skills --skill documentation-standards-terrylica

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Markdown documentation standards designed for machine readability and reliable PDF conversion via Pandoc, ensuring consistent structure and provenance across skills.

Core Features & Use Cases

Hub-and-Spoke Structure: Central hub documentation with progressive spokes (skills docs) linking to detailed references.
Markdown Formatting: Semantic headings, non-numbered sections, and code blocks with language identifiers.
Machine-Readable Contracts: Guidance for OpenAPI specs, JSON Schemas, and YAML configurations to support automation.

Quick Start

Apply standards when creating a new skill doc by organizing a hub page that links to a SKILL.md with references in a dedicated references/ folder.