documentation-standards SKILL.md skillA
documentation-standards from terrylica/cc-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add terrylica/cc-skills/documentation-standards@git:20260923.cfe9725Pins git:20260923.cfe9725 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- terrylica/cc-skills
- Path
plugins/doc-tools/skills/documentation-standards/SKILL.md- Versions recorded
- 5
- Latest version
- git:20260923.cfe9725, committed Sep 23, 2026
- First version recorded
- Mar 6, 2026
- Size
- 7,370 bytes
- Repository stars
- 2
- License
- MIT
Apply markdown documentation standards for both LLM consumption and Pandoc PDF export: section numbering, formatting and style. Use when writing or reviewing documentation.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file 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
mdr add terrylica/cc-skills/documentation-standards@sha256:76a45ca9e8815e6dThe line at the top of this page pins the label git:20260923.cfe9725, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_dz3gx4htkgb2kt72)
4 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 5 versions of this file, between Mar 6, 2026 and Sep 23, 2026, about one every 50 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260923.cfe9725 latest | 2026-09-23 | cfe9725 | 7,370 B | A | view · diff |
| git:20260506.fd8a4c9 | 2026-05-06 | fd8a4c9 | 7,333 B | A | view · diff |
| git:20260401.d376871 | 2026-04-01 | d376871 | 7,635 B | A | view · diff |
| git:20260401.1380431 | 2026-04-01 | 1380431 | 7,413 B | A | view · diff |
| git:20260306.9b09b28 | 2026-03-06 | 9b09b28 | 6,843 B | A | view |
Audit of the latest version
- 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
terrylica/cc-skills · 2 stars · license MIT · pushed 2026-11-08 · 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 AI assistant 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.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.
More from terrylica/cc-skills
Every file in terrylica/cc-skills