Home / hoangnguyen0403 / agent-skills-standard · .claude/skills/common/common-documentation/SKILL.md · GitHub

common-documentation skillA

Name: common-documentation
Author: hoangnguyen0403

This file is byte-identical to the first copy the registry indexed, one of 3 copies on public GitHub. Same content hash, same audit grade.

common-documentation is agent-read markdown (skill) from hoangnguyen0403/agent-skills-standard: Write effective code comments, READMEs, and technical documentation following intent-first principles. Use when adding comments, writing docstrings, creating READMEs, or updating any documentation..

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

# 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

Latest version

mdr add hoangnguyen0403/agent-skills-standard/common-documentation@git:20260821.b9b1ba0

Exact content

mdr add hoangnguyen0403/agent-skills-standard/common-documentation@sha256:6776809cdf947de0

Pin 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.

Badge

[![mdr](https://markdownregistry.com/badge/art_iyriysxp2cgjp4mp.svg)](https://markdownregistry.com/a/art_iyriysxp2cgjp4mp)

1 badge views in 30 days

Versions

version	committed	commit	size	audit
git:20260821.b9b1ba0 latest	2026-08-21	b9b1ba0	1,752 B	A	view

Audit of the latest version

A 17 of 17 checks passed. Deterministic, no model, same answer every run.

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

GitHub

hoangnguyen0403/agent-skills-standard · 571 stars · license MIT · pushed 2026-09-24 · branch develop

API

GET https://markdownregistry.com/api/v1/artifacts/art_iyriysxp2cgjp4mp
GET https://markdownregistry.com/api/v1/resolve?ref=hoangnguyen0403/agent-skills-standard/common-documentation
GET https://markdownregistry.com/api/v1/blob/6776809cdf947de0be1e5b596c145dd744973fc9fa235fdf598e3550d3283248

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.

More from hoangnguyen0403/agent-skills-standard

caveman-commit skill

hoangnguyen0403/agent-skills-standard · .agents/skills/caveman-commit/SKILL.md · Ultra-compressed commit message generator. Cuts noise from commit messages while preserving intent and reasoning…

git:20260509.3e36716 · audit A · 571 stars

caveman-compress skill

hoangnguyen0403/agent-skills-standard · .agents/skills/caveman-compress/SKILL.md · Compress natural language memory files (CLAUDE.md, todos, preferences) into caveman format to save input tokens…

git:20260509.3e36716 · audit A · 571 stars

caveman-review skill

hoangnguyen0403/agent-skills-standard · .agents/skills/caveman-review/SKILL.md · Ultra-compressed code review comments. Cuts noise from PR feedback while preserving the actionable signal. Each comment…

git:20260509.3e36716 · audit A · 571 stars

caveman skill

hoangnguyen0403/agent-skills-standard · .agents/skills/caveman/SKILL.md · Ultra-compressed communication mode. Cuts token usage ~75% by speaking like caveman while keeping full technical…

git:20260509.3e36716 · audit A · 571 stars

common-architecture-diagramming skill

hoangnguyen0403/agent-skills-standard · .agents/skills/common/common-architecture-diagramming/SKILL.md · Draw architecture diagrams as editable draw.io files with a fixed house style, C4 levels, and evidence-tagged shapes…

git:20260913.58fa467 · audit A · 571 stars

common-best-practices skill

hoangnguyen0403/agent-skills-standard · .agents/skills/common/common-best-practices/SKILL.md · Enforce SOLID principles, guard-clause style, function size limits, and intention-revealing naming across all…