document-code SKILL.md skillA
document-code from jjmartres/ai-coding-agents is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add jjmartres/ai-coding-agents/document-code@git:20260909.d205857Pins git:20260909.d205857 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- jjmartres/ai-coding-agents
- Path
shared/.ai-agents/skills/document-code/SKILL.md- Versions recorded
- 3
- Latest version
- git:20260909.d205857, committed Sep 9, 2026
- First version recorded
- Apr 29, 2026
- Size
- 11,612 bytes
- Repository stars
- 48
- License
- MIT
Apply Google Style documentation standards to Python, Go, TypeScript, and Terraform code. Use when writing or reviewing code that needs docstrings/comments/JSDoc, when asked to "document this code", "add docstrings", "follow Google Style", or when improving code documentation quality. Supports Python docstrings, Go comments, TypeScript JSDoc, and Terraform variable/output descriptions. Enforces consistent, professional documentation standards.
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
# Code Documentation Standards Apply Google Style documentation standards to Python (docstrings), Go (comments), TypeScript (JSDoc), and Terraform (descriptions). Ensures consistent, professional, and comprehensive code documentation across multiple languages. ## When to Apply This Skill Use this skill when: - Writing new functions, classes, or packages - Reviewing code for documentation quality - User requests "document this code" or "add docstrings" - User mentions "Google Style" or documentation standards - Refactoring code that lacks proper documentation - Creating code examples that should be well-documented ## Core Principles 1. **Clarity**: Documentation should be immediately understandable 2. **Completeness**: Document all public APIs, parameters, returns, exceptions 3. **Consistency**: Follow language-specific Google Style conventions 4. **Conciseness**: Be thorough but avoid redundancy 5. **Examples**: Include usage examples for complex functionality ## Workflow ### 1. Detect Language Identify the programming language: - **Python**: Look for `.py` files, `def`, `class` keywords, type hints - **Go**: Look for `.go` files, `func`, `type`, `package` keywords …
Read the whole file at its exact version.
How to install
mdr add jjmartres/ai-coding-agents/document-code@sha256:8c05aba564760112The line at the top of this page pins the label git:20260909.d205857, 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_zralisrwabo2zv5q)
2 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 3 versions of this file, between Apr 29, 2026 and Sep 9, 2026, about one every 67 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260909.d205857 latest | 2026-09-09 | d205857 | 11,612 B | A | view · diff |
| git:20260909.4e52357 | 2026-09-09 | 4e52357 | 11,611 B | A | view · diff |
| git:20260429.47a6786 | 2026-04-29 | 47a6786 | 10,370 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 (11612 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
jjmartres/ai-coding-agents · 48 stars · license MIT · pushed 2026-10-22 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_zralisrwabo2zv5q GET https://markdownregistry.com/api/v1/resolve?ref=jjmartres/ai-coding-agents/document-code GET https://markdownregistry.com/api/v1/blob/8c05aba564760112b925f632bc4516a3000409389a5682a460efc1a15f4c47ba
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 jjmartres/ai-coding-agents
Every file in jjmartres/ai-coding-agents