terrylica avatar

Documentation Standards

Enforces markdown standards designed for both LLM consumption and Pandoc PDF generation. The big rule: never manually number headings because Pandoc's auto-numbering will create duplicates like "1. 1. Introduction". Pushes hub-and-spoke architecture where essential docs link to detailed references, and prioritizes machine-readable formats like OpenAPI specs and JSON Schema over prose when possible. Includes a checklist for structure, formatting, and file organization. Use it when writing READMEs, skill docs, or any markdown that might become a PDF. The self-evolving approach means you fix the skill file immediately when something doesn't work, which is practical.

skills.sh installs
161
GitHub stars
2
last updated
Aug 21, 2026

Install

$ npx -y skills add terrylica/cc-skills --skill documentation-standards --agent claude-code

Installs into .claude/skills of the current project.

Files

Documentation Standards

Self-Evolving Skill: This skill improves through use. If instructions are wrong, parameters drifted, or a workaround was needed — fix this file immediately, don't defer. Only update for real, reproducible issues.

Overview

Standards for writing markdown documentation optimized for both LLM consumption and conversion to professional PDFs using Pandoc. Ensures consistency across all documentation.

When to Use This Skill

Use when:

  • Writing markdown documentation (README, skills, guides, specifications)
  • Creating new skills that include markdown content
  • Authoring content that may be converted to PDF
  • Reviewing documentation for standards compliance

Core Principles

1. LLM-Optimized Documentation Architecture

Machine-Readable Priority: OpenAPI 3.1.0 specs, JSON Schema, YAML specifications take precedence over human documentation.

Why: Structured formats provide unambiguous contracts that both humans and LLMs can consume reliably. Human docs supplement, don't replace, machine-readable specs.

Application:

Sponsors

Details

Repository
github.com/terrylica/cc-skills
Categories
Documentation, AI & Agent Building, Office & Documents
First seen
Jun 3, 2026

More from terrylica/cc-skills

All 15
1yelban avatargood-writing-zhyelban/orz99-skills中文好寫作指南:提升中文寫作品質與改寫既有文章。基於 Paul Graham、余光中、王鼎鈞的寫作智慧。 使用時機: - 用戶說「潤稿」「改寫」「rewrite」「讓文字更順」 - 用戶要求「改善文筆」「寫好一點」「高品質中文」 - 用戶提供文章並要求修改或潤飾 - 需要產出高品質中文內容時 技術文件(README、A153skills.sh installs
2salesforcecommercecloud avatarb2c-docssalesforcecommercecloud/b2c-developer-toolingSearch and read B2C Commerce documentation using the b2c CLI. Covers Script API reference (dw.* classes/modules), Developer Center guides (Commerce API, PWA Kit145skills.sh installs
3fuma-nama avatarread-docsfuma-nama/fumadocsEnables efficient, accurate retrieval of content from Fumadocs-powered documentation sites.134skills.sh installs
4ganyuanran avatarwriting-skillsganyuanran/aegisIf you're building skills for Claude, this is your meta-guide.0skills.sh installs
5hoangnguyen0403 avatarupdate-docshoangnguyen0403/agent-skills-standardAutomated workflow to detect and fix missing documentation0skills.sh installs
6metabase avatardocs-writemetabase/metabaseWrite documentation following Metabase's conversational, clear, and user-focused style. Use when creating or editing documentation files (markdown, MDX, etc.).0skills.sh installs