comments-docs skillA
comments-docs is agent-read markdown (skill) from codybrom/clairvoyance: 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)..
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
# 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@git:20260722.fcfda01mdr add codybrom/clairvoyance/comments-docs@sha256:c3e26c87a88cc65ePin 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.
[](https://markdownregistry.com/a/art_474mthzhqovqtrkb)
1 badge views in 30 days
Versions
| 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 · 12 stars · license MIT · pushed 2026-09-20 · 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 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.