documentation-standards SKILL.md skillA
documentation-standards from sigistry/marketplace is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add sigistry/marketplace/documentation-standards@v1.0.0Pins v1.0.0 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- sigistry/marketplace
- Path
plugins/doc-generator/skills/documentation-standards/SKILL.md- Versions recorded
- 2
- Latest version
- v1.0.0, committed Aug 26, 2026
- First version recorded
- Mar 8, 2026
- Size
- 10,448 bytes
- Repository stars
- 3
- License
- MIT
This skill should be used when the user asks to "document code", "add documentation", "write docstrings", "add JSDoc", "fix documentation", "update docs", "check documentation quality", "add doc comments", or "generate API docs". Provides language-specific documentation format knowledge and quality standards for generating, updating, and auditing code 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
## Purpose
Define language-specific documentation formats, quality standards, and writing principles for generating, auditing, and maintaining code documentation. Apply these standards consistently across all documentation-related operations.
## Core Principles
### Explain the Why, Not the What
Focus documentation on intent, rationale, and context rather than restating what the code already expresses. A function named `calculateTax` does not need a description that says "calculates tax." Instead, describe which tax rules apply, what edge cases exist, and why a particular algorithm was chosen.
**Weak:**
```javascript
/** Sorts the array. */
function sortUsers(users) { ... }
```
**Strong:**
```javascript
/**
* Sort users by subscription tier (premium first), then by join date.
*
* Premium users appear first to ensure priority support routing.
* Within the same tier, older accounts take precedence per SLA policy.
*/
function sortUsers(users) { ... }
```
### Use Active Voice
Write descriptions in active voice, present tense. Start function descriptions with a verb.
| Preferred | Avoid |
|-----------|-------|
…Read the whole file at its exact version.
How to install
mdr add sigistry/marketplace/documentation-standards@sha256:8d9a0058c25f98d2The line at the top of this page pins the label v1.0.0, 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_vcssv3djrugjrow2)
7 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 2 versions of this file, between Mar 8, 2026 and Aug 26, 2026, about one every 171 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| v1.0.0 latest | 2026-08-26 | 571bc2f | 10,448 B | A | view · diff |
| v1.0.0 | 2026-03-08 | 09146c8 | 10,448 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 (10448 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
sigistry/marketplace · 3 stars · license MIT · pushed 2026-11-06 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_vcssv3djrugjrow2 GET https://markdownregistry.com/api/v1/resolve?ref=sigistry/marketplace/documentation-standards GET https://markdownregistry.com/api/v1/blob/8d9a0058c25f98d261bdf945e7261e5929b36dd8f3d06c4943ec83c4a862cf30
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 sigistry/marketplace
Every file in sigistry/marketplace