docs-code-sample-standards SKILL.md skillA
docs-code-sample-standards from samber/developer-relations-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add samber/developer-relations-skills/docs-code-sample-standards@v1.0.2Pins v1.0.2 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- samber/developer-relations-skills
- Path
skills/docs-code-sample-standards/SKILL.md- Versions recorded
- 4
- Latest version
- v1.0.2, committed Oct 25, 2026
- First version recorded
- Sep 2, 2026
- Size
- 23,358 bytes
- Repository stars
- 8
- License
- MIT
Defines the policy every code sample in developer documentation must meet and audits an existing sample corpus against it, returning a ranked fix queue. Use whenever the user mentions docs code samples, code snippets in documentation, runnable examples, examples that no longer compile, copy-paste failures, snippet drift after an API change, testing docs examples in CI, SDK snippet parity across languages, sample maintenance ownership, or asks why the examples in their docs do not work - even…
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
# Docs Code Sample Standards You are a developer-documentation engineer. You produce two artefacts: a **sample policy** (the rules every published code sample must satisfy) and a **sample audit** that scores the existing corpus against that policy and ranks what to fix. A code sample is the only part of the docs a reader executes. Prose that is slightly wrong wastes a minute; a sample that is slightly wrong ships into their codebase. Uddin and Robillard's 2015 survey of 323 professional developers found ambiguity, incompleteness, and incorrectness the severest API-documentation problems, with six of the ten problem types they documented rated outright blockers. The survey covers API documentation as a whole, and samples are where all three defects get executed rather than merely read. Treat samples as a tested artefact with an owner, not as decoration inside a page. ## Scope check Confirm the task is really about the sample corpus before starting. Route elsewhere when: - The task is writing one zero-to-first-success page → quickstart skill. - The task is a teaching tutorial rather than the samples inside it → tutorial skill. …
Read the whole file at its exact version.
How to install
mdr add samber/developer-relations-skills/docs-code-sample-standards@sha256:04707d3990cb950fThe line at the top of this page pins the label v1.0.2, 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_jzmtbnoqey25scmc)
2 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 4 versions of this file, between Sep 2, 2026 and Oct 25, 2026, about one every 18 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| v1.0.2 latest | 2026-10-25 | 2c2141c | 23,358 B | A | view · diff |
| v1.0.1 | 2026-09-27 | bc8ac6d | 23,348 B | A | view · diff |
| v1.0.0 | 2026-09-02 | 9ca3bc1 | 22,983 B | A | view · diff |
| v1.0.0 | 2026-09-02 | 22b464c | 22,982 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 (23358 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
samber/developer-relations-skills · 8 stars · license MIT · pushed 2026-11-01 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_jzmtbnoqey25scmc GET https://markdownregistry.com/api/v1/resolve?ref=samber/developer-relations-skills/docs-code-sample-standards GET https://markdownregistry.com/api/v1/blob/04707d3990cb950f39391006beaad6951cd3f2c4776e772e0b5bedbbbf525ce4
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.