apply documentation philosophy — explain why, not what. use for jsdocs, READMEs, inline comments.
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
# document
apply documentation philosophy: explain why, not what.
## when to use
- writing jsdocs for components or functions
- updating README or project docs
- adding inline comments during implementation
- reviewing existing documentation for cleanup
## workflow
1. check if documentation is needed — if it describes obvious behavior, skip it
2. identify the non-obvious why: design constraints, behavioral consequences, inheritance warnings
3. write terse, lowercase prose
4. delete anything that merely restates the code
## quick reference: why over what
**delete this:**
```typescript
/** context provider that wraps children in a DisclosureProvider. */
```
**keep this:**
```typescript
/**
* blocks CompositeContext so nested Lists create isolated focus loops.
* essential for "Simple API" goal — our List is "greedy" and would
* otherwise join parent's arrow-key navigation.
*/
```
## what to document
- design rationale and constraints
- context shadowing / inheritance warnings
- non-obvious behavioral consequences
- internal decisions affecting correctness
## what to delete
- obvious behavior ("renders a button")
- what the function name already says
…
The line at the top of this page pins the label git:20260825.12ce506, 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.
GET https://markdownregistry.com/api/v1/artifacts/art_urlkoxccpzlfqt6w
GET https://markdownregistry.com/api/v1/resolve?ref=bdsqqq/dots/document
GET https://markdownregistry.com/api/v1/blob/aa7f02fc545e3aba049b1d0732a26e057be55212716c65a44653cb23a843159b
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.
bdsqqq/dots · modules/agents/skills/building-review-playgrounds/SKILL.md · Exposes hard-to-reach UI states through issue-scoped production-component fixtures. Use when existing routes or stories…
bdsqqq/dots · modules/agents/skills/buying-stuff/SKILL.md · helps choose what to buy and where to buy it, based on the user's priorities, budget, and location. use for shopping…
bdsqqq/dots · modules/agents/skills/company-money/SKILL.md · Ingests bounded Wise Gmail notifications and Nubank statements into the private local company ledger, then produces…
bdsqqq/dots · modules/agents/skills/composing-data-driven-ui/SKILL.md · Makes data-backed UI work outside its original page. Use when callers need to supply data or fetch by ID, or reuse a…
bdsqqq/dots · modules/agents/skills/data-visualization/SKILL.md · Use when creating, reviewing, or styling charts, graphs, dashboards, sparklines, or any data visualization.
bdsqqq/dots · modules/agents/skills/designing-progressive-apis/SKILL.md · Designs type-safe APIs with useful defaults and room for caller control. Use for overloads, render slots, compound…
bdsqqq/dots · modules/agents/skills/desloping-code-changes/SKILL.md · Tests whether code-change complexity is justified by behavior and local contracts. Use for a focused craft review of…
oliver-kriska/claude-elixir-phoenix · plugins/elixir-phoenix/skills/document/SKILL.md · Use when asked to document Elixir code: add or fill in @moduledoc and @doc for modules and functions. Documents tested…
serpro69/claude-toolbox · kodex-plugin/skills/document/SKILL.md · After implementing a new feature or fixing a bug, make sure to document the changes.
Use when writing documentation…
serpro69/claude-toolbox · klaude-plugin/skills/document/SKILL.md · After implementing a new feature or fixing a bug, make sure to document the changes.
Use when writing documentation…
archcore-ai/archcore · plugins/archcore/skills/document/SKILL.md · Record a decision, document existing code, or file a supplied research material, in free text; no first word is a mode…
archcore-ai/plugin · plugins/archcore/skills/document/SKILL.md · Record a decision, document existing code, or file a supplied research material, in free text; no first word is a mode…
awrshift/agent-memory-kit · plugins/memory-kit/skills/document/SKILL.md · Write the human-facing prose about a change — PR body · changelog entry · release note · postmortem — and put it in the…
