common-documentation SKILL.md skillA
common-documentation from hoangnguyen0403/agent-skills-standard is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add hoangnguyen0403/agent-skills-standard/common-documentation@git:20260714.6bf9b5ePins git:20260714.6bf9b5e in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- hoangnguyen0403/agent-skills-standard
- Path
.codex/skills/common/common-documentation/SKILL.md- Versions recorded
- 2
- Latest version
- git:20260714.6bf9b5e, committed Jul 14, 2026
- First version recorded
- May 13, 2026
- Size
- 1,752 bytes
- Repository stars
- 583
- License
- MIT
Write effective code comments, READMEs, and technical documentation following intent-first principles. Use when adding comments, writing docstrings, creating READMEs, or updating any 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 ## **Priority: P2 (MEDIUM)** ## 1. Intent-First Comments - Explain **"Why"** logic exists. Avoid "What" mechanics. - Use triple-slash (Dart/Swift) or JSDoc (TS/JS) for public members. - Delete commented-out code. Use Git history. - Format: `TODO(username): description`. Link tickets. - For retry backoff, explain that jitter prevents the **thundering herd**; document intent rather than restating the delay calculation. ## 2. README Structure - **Mission**: Project purpose (one sentence). - **Onboarding**: Prerequisites, installation, usage (exact). - **Maintenance**: Document inputs/outputs, known quirks, fixes. - **Sync**: Documentation ships with feature. ## 3. ADRs & Architecture - **ADRs**: Document rationale for system changes in `docs/adr/`. - **Docstrings**: Include Args, Returns, and Usage examples (`>>>`). - **Diagrams**: Use Mermaid.js inside Markdown. ## 4. API Docs - Use Swagger/OpenAPI for REST. - Provide copy-pasteable examples for endpoints. - Define contract before implementation. ## Anti-Patterns - **No "what" comments**: Explain intent. Refactor mechanics. - **No orphan TODOs**: Require owner and ticket. …
Read the whole file at its exact version.
How to install
mdr add hoangnguyen0403/agent-skills-standard/common-documentation@sha256:6776809cdf947de0The line at the top of this page pins the label git:20260714.6bf9b5e, 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_irxkzspgfgdqcwax)
3 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 2 versions of this file, between May 13, 2026 and Jul 14, 2026, about one every 62 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260714.6bf9b5e latest | 2026-07-14 | 6bf9b5e | 1,752 B | A | view · diff |
| git:20260513.7eab4bf | 2026-05-13 | 7eab4bf | 1,438 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 (1752 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
hoangnguyen0403/agent-skills-standard · 583 stars · license MIT · pushed 2026-11-07 · branch develop
API
GET https://markdownregistry.com/api/v1/artifacts/art_irxkzspgfgdqcwax GET https://markdownregistry.com/api/v1/resolve?ref=hoangnguyen0403/agent-skills-standard/common-documentation GET https://markdownregistry.com/api/v1/blob/6776809cdf947de0be1e5b596c145dd744973fc9fa235fdf598e3550d3283248
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 hoangnguyen0403/agent-skills-standard
Every file in hoangnguyen0403/agent-skills-standard