documenting-code SKILL.md skillA

documenting-code from alexei-led/cc-thingz is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add alexei-led/cc-thingz/documenting-code@git:20261005.de984fb

Pins git:20261005.de984fb in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
alexei-led/cc-thingz
Path
src/skills/documenting-code/SKILL.md
Versions recorded
10
Latest version
git:20261005.de984fb, committed Oct 5, 2026
First version recorded
Jun 2, 2026
Size
5,822 bytes
Repository stars
38
License
MIT

Write, rewrite, or update project docs from implementation facts - README.

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

# Documenting Code

Turn implementation facts into docs that a named reader can use. Every claim in
the result matches the code, and every visual renders cleanly.

## Pick the mode

- **Update**: a code change made docs stale. Change the smallest set of docs.
  Done when each changed behavior is documented where its reader looks, and
  nothing unrelated changed.
- **Overhaul**: the user asks to rewrite, restructure, or improve a doc set, for
  example a README front page, guides, or an architecture doc. Done when:
  - each doc has one reader and one job, and each fact has one owner
  - every claim matches the code, and every visual passes its render check
  - the gate passes
- A named doc or a named change is enough scope; start work. Ask only when the
  request names neither, with one question and these options: auto-detect from
  recent changes, README, API docs, or the full doc set.

## Readers

Decide the reader before writing.

- **Human**: short, scannable text. Use a diagram, table, or chart when it
  answers a question faster than prose. Load `references/doc-set.md` only for
  doc-set structure or Overhaul mode, `references/style.md` when rewriting prose,
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add alexei-led/cc-thingz/documenting-code@sha256:84cc8f8752446370

The line at the top of this page pins the label git:20261005.de984fb, 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.

Badge

mdr badge

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

3 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 10 versions of this file, between Jun 2, 2026 and Oct 5, 2026, about one every 14 days. Its first recorded version is graded B and its latest A.

versioncommittedcommitsizeaudit
git:20261005.de984fb latest2026-10-05 de984fb 5,822 BA view · diff
git:20261004.975fe0a2026-10-04 975fe0a 5,641 BA view · diff
git:20260928.c6d8b392026-09-28 c6d8b39 5,572 BA view · diff
git:20260924.ba855462026-09-24 ba85546 6,155 BA view · diff
git:20260924.a6b603a2026-09-24 a6b603a 6,111 BA view · diff
git:20260716.29b4d222026-07-16 29b4d22 5,118 BA view · diff
git:20260705.2c521402026-07-05 2c52140 5,121 BB view · diff
git:20260627.b14ceca2026-06-27 b14ceca 5,118 BB view · diff
git:20260603.e6aca852026-06-03 e6aca85 5,011 BB view · diff
git:20260602.53635f92026-06-02 53635f9 3,143 BB view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the 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 (5822 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

alexei-led/cc-thingz · 38 stars · license MIT · pushed 2026-10-25 · branch master

API

GET https://markdownregistry.com/api/v1/artifacts/art_qy2qp6scsgem6fn7
GET https://markdownregistry.com/api/v1/resolve?ref=alexei-led/cc-thingz/documenting-code
GET https://markdownregistry.com/api/v1/blob/84cc8f875244637059792f27722601d0e0655566cc4dd335d38c62381ca5a69e

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 alexei-led/cc-thingz

AGENTS.md AGENTS.md file
alexei-led/cc-thingz · AGENTS.md
git:20261010.bc87856 · audit A · 38 stars
CLAUDE.md CLAUDE.md file
alexei-led/cc-thingz · CLAUDE.md
git:20260512.586616a · audit B · 38 stars
brainstorming-ideas SKILL.md skill
alexei-led/cc-thingz · src/skills/brainstorming-ideas/SKILL.md · Brainstorm ideas and stress-test draft plans before coding. Use when
git:20261021.2f01d27 · audit A · 38 stars
browser-automation SKILL.md skill
alexei-led/cc-thingz · src/skills/browser-automation/SKILL.md · 'Browser automation for rendered UI exploration, validation, screenshots,
git:20260928.aef806a · audit A · 38 stars
cleanup-git SKILL.md skill
alexei-led/cc-thingz · src/skills/cleanup-git/SKILL.md · Remove merged local branches and stale git worktrees. Use when the user
git:20261021.a9f3052 · audit A · 38 stars
committing-code SKILL.md skill
alexei-led/cc-thingz · src/skills/committing-code/SKILL.md · Create normal git commits with logical grouping. Use when committing,
git:20261005.de984fb · audit A · 38 stars
configuring-git-hygiene SKILL.md skill
alexei-led/cc-thingz · src/skills/configuring-git-hygiene/SKILL.md · 'Configure safe git workflow hygiene: pre-commit/pre-push hooks, Gitleaks
git:20260928.296db92 · audit A · 38 stars
evolving-config SKILL.md skill
alexei-led/cc-thingz · src/skills/evolving-config/SKILL.md
git:20260928.23d332d · audit B · 38 stars
fixing-code SKILL.md skill
alexei-led/cc-thingz · src/skills/fixing-code/SKILL.md · Fix code defects with a reproducible feedback loop, root-cause diagnosis,
git:20261021.2f01d27 · audit A · 38 stars
improving-tests SKILL.md skill
alexei-led/cc-thingz · src/skills/improving-tests/SKILL.md · Improve test design, speed, and coverage with behavior-focused tests,
git:20261021.2f01d27 · audit A · 38 stars
installation-doctor SKILL.md skill
alexei-led/cc-thingz · src/skills/installation-doctor/SKILL.md · Diagnose cc-thingz plugin installations with the bundled read-only doctor. Use for missing installed skills, helpers…
git:20260929.e2cd2eb · audit A · 38 stars
looking-up-docs SKILL.md skill
alexei-led/cc-thingz · src/skills/looking-up-docs/SKILL.md · Find exact, version-correct library/API/framework docs through one lookup
git:20260928.aef806a · audit A · 38 stars

Every file in alexei-led/cc-thingz

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