comments-docs SKILL.md skillA
comments-docs from codybrom/clairvoyance is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add codybrom/clairvoyance/comments-docs@git:20260722.fcfda01Pins git:20260722.fcfda01 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- codybrom/clairvoyance
- Path
skills/comments-docs/SKILL.md- Versions recorded
- 5
- Latest version
- git:20260722.fcfda01, committed Jul 22, 2026
- First version recorded
- Feb 27, 2026
- Size
- 7,434 bytes
- Repository stars
- 15
- License
- MIT
Reviews comment quality and documentation practices: the four comment types, comments-first workflow, and comment rot. Use when reviewing comments or docs, when comments just repeat the code, or when something is hard to describe in a sentence. Not for naming or code obviousness (use naming-obviousness).
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
# Comments & Documentation Review Lens When invoked with $ARGUMENTS, focus the analysis on the specified file or module. Read the target code first, then apply the checks below. **Comments are not recording a design that already exists. They are the medium in which the design is discovered.** Code captures mechanism. Comments capture meaning. Even a perfect programming language could not replace them. The information types are distinct. ## When to Apply - Reviewing code with comments (or conspicuously lacking them) - When writing new interfaces and considering documentation strategy - When comments feel useless or redundant - When a module is hard to use despite having documentation ## Core Principles ### The Guiding Principle > "Comments should describe things that aren't obvious from the code." — John Ousterhout, _A Philosophy of Software Design_ "Obvious" is from the perspective of someone reading the code for the first time, not the author. If a reviewer says something isn't obvious, it isn't. Don't argue, clarify. ### Four Comment Types #### 1. Interface Comments …
Read the whole file at its exact version.
How to install
mdr add codybrom/clairvoyance/comments-docs@sha256:c3e26c87a88cc65eThe line at the top of this page pins the label git:20260722.fcfda01, 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_474mthzhqovqtrkb)
4 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 5 versions of this file, between Feb 27, 2026 and Jul 22, 2026, about one every 36 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260722.fcfda01 latest | 2026-07-22 | fcfda01 | 7,434 B | A | view · diff |
| git:20260701.ba096c5 | 2026-07-01 | ba096c5 | 7,532 B | A | view · diff |
| git:20260301.1854d20 | 2026-03-01 | 1854d20 | 7,226 B | A | view · diff |
| git:20260227.455211b | 2026-02-27 | 455211b | 7,334 B | A | view · diff |
| git:20260227.e9a9629 | 2026-02-27 | e9a9629 | 7,383 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 (7434 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
codybrom/clairvoyance · 15 stars · license MIT · pushed 2026-10-08 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_474mthzhqovqtrkb GET https://markdownregistry.com/api/v1/resolve?ref=codybrom/clairvoyance/comments-docs GET https://markdownregistry.com/api/v1/blob/c3e26c87a88cc65e7d91602d11fba1fdb01629d455e7c3d25eaaa5456476ebc4
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.