Home / terrylica / cc-skills · plugins/doc-tools/skills/documentation-standards/SKILL.md · GitHub

documentation-standards skillA

documentation-standards is agent-read markdown (skill) from terrylica/cc-skills: Apply markdown documentation standards for both LLM consumption and Pandoc PDF export: section numbering, formatting and style. Use when writing or reviewing documentation..

Indexed from public GitHub and served as immutable, content-addressed versions. Install it pinned to an exact SHA-256 with the mdr CLI, and every file is verified against the hash recorded here before it reaches your agent. The deterministic audit below grades the latest version, and the same file always earns the same grade.

What the file says

# 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**:

- Workflow specifications → OpenAPI 3.1.1 YAML in specifications/
- Data schemas → JSON Schema with examples
…

Read the whole file at its exact version.

How to install

Latest version
mdr add terrylica/cc-skills/documentation-standards@git:20260923.cfe9725
Exact content
mdr add terrylica/cc-skills/documentation-standards@sha256:76a45ca9e8815e6d

Pin to a label to follow the author's releases, or to a sha256 to freeze the exact bytes forever. Either way the resolved hash is written to mdr.lock, and mdr install reproduces it on any machine.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_dz3gx4htkgb2kt72.svg)](https://markdownregistry.com/a/art_dz3gx4htkgb2kt72)

0 badge views in 30 days

Versions

versioncommittedcommitsizeaudit
git:20260923.cfe9725 latest2026-09-23 cfe9725 7,370 BA view · diff
git:20260506.fd8a4c92026-05-06 fd8a4c9 7,333 BA view · diff
git:20260401.d3768712026-04-01 d376871 7,635 BA view · diff
git:20260401.13804312026-04-01 1380431 7,413 BA view · diff
git:20260306.9b09b282026-03-06 9b09b28 6,843 BA view

Audit of the latest version

A  17 of 17 checks passed. Deterministic, no model, same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (7370 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

terrylica/cc-skills · 74 stars · license MIT · pushed 2026-09-24 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_dz3gx4htkgb2kt72
GET https://markdownregistry.com/api/v1/resolve?ref=terrylica/cc-skills/documentation-standards
GET https://markdownregistry.com/api/v1/blob/76a45ca9e8815e6d508a792d5167c48f32c8aa4ae90d29f22d3646016e949910

Your agent does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

More from terrylica/cc-skills

CLAUDE.md claude
terrylica/cc-skills · CLAUDE.md
git:20260920.d5f6026 · audit A · 74 stars
CLAUDE.md@docs claude
terrylica/cc-skills · docs/CLAUDE.md
git:20260903.abf94c3 · audit A · 74 stars
CLAUDE.md@docs/design claude
terrylica/cc-skills · docs/design/CLAUDE.md
git:20260903.3d243d7 · audit A · 74 stars
CLAUDE.md@plugins claude
terrylica/cc-skills · plugins/CLAUDE.md
git:20260920.d5f6026 · audit A · 74 stars
CLAUDE.md@plugins/agent-reach claude
terrylica/cc-skills · plugins/agent-reach/CLAUDE.md
git:20260722.52c9284 · audit A · 74 stars
agent-reach skill
terrylica/cc-skills · plugins/agent-reach/skills/agent-reach/SKILL.md · Give your AI agent eyes to see the entire internet. 17 platforms via CLI, MCP, curl, and Python scripts. Zero config…
git:20260527.fb73e18 · audit A · 74 stars
CLAUDE.md@plugins/arxiv-source-first claude
terrylica/cc-skills · plugins/arxiv-source-first/CLAUDE.md
git:20260822.291af0a · audit A · 74 stars
arxiv-source-first-paper-ingest skill
terrylica/cc-skills · plugins/arxiv-source-first/skills/arxiv-source-first-paper-ingest/SKILL.md · Read an arXiv paper faithfully by fetching the authors' own LaTeX source instead of OCR-ing the PDF. Extracts every…
git:20260731.1bd7c64 · audit A · 74 stars
CLAUDE.md@plugins/asciinema-tools claude
terrylica/cc-skills · plugins/asciinema-tools/CLAUDE.md
git:20260812.1b1cc81 · audit A · 74 stars
analyze skill
terrylica/cc-skills · plugins/asciinema-tools/skills/analyze/SKILL.md · Semantic analysis of converted recordings. TRIGGERS - analyze cast, keyword extraction, find patterns.
git:20260401.b664eaf · audit A · 74 stars
asciinema-analyzer skill
terrylica/cc-skills · plugins/asciinema-tools/skills/asciinema-analyzer/SKILL.md · Semantic analysis of asciinema recordings. TRIGGERS - analyze cast, keyword extraction, find patterns in recordings.
git:20260401.b664eaf · audit A · 74 stars
asciinema-cast-format skill
terrylica/cc-skills · plugins/asciinema-tools/skills/asciinema-cast-format/SKILL.md · Asciinema v3 .cast file format reference. TRIGGERS - cast format, asciicast spec, event codes, parse cast file.
git:20260401.b664eaf · audit A · 74 stars

Every file in terrylica/cc-skills

Other files named documentation-standards

documentation-standards skill
d-padmanabhan/agent-engineering-handbook · skills/documentation-standards/SKILL.md · Documentation best practices including Markdown formatting, generated PNG diagrams, technical writing, ADRs, Docusaurus…
git:20260906.8d25679 · audit A · 17 stars
documentation-standards skill
sigistry/marketplace · plugins/doc-generator/skills/documentation-standards/SKILL.md · This skill should be used when the user asks to "document code", "add documentation", "write docstrings", "add JSDoc"…
v1.0.0 · audit A · 3 stars

Browse by kind, by grade A, or by owner.