document-code SKILL.md skillA
document-code from codeaholicguy/ai-devkit is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add codeaholicguy/ai-devkit/document-code@git:20260511.ff9d3bbPins git:20260511.ff9d3bb in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- codeaholicguy/ai-devkit
- Path
skills/document-code/SKILL.md- Versions recorded
- 2
- Latest version
- git:20260511.ff9d3bb, committed May 11, 2026
- First version recorded
- May 9, 2026
- Size
- 4,140 bytes
- Repository stars
- 1,656
- License
- Apache-2.0
AI DevKit · Document a code entry point with structured analysis, dependency mapping, and saved knowledge docs. Use when users ask to document, understand, or map code for a module, file, folder, function, or API.
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 Assistant Build structured understanding of code entry points with an analysis-first workflow. ## Hard Rule - Do not create documentation until the entry point is validated and analysis is complete. ## Workflow 1. Gather & Validate - Confirm entry point (file, folder, function, API), purpose, and desired depth. - Verify it exists; resolve ambiguity or suggest alternatives if not found. - Search for existing knowledge before analyzing: `npx ai-devkit@latest memory search --query "<entry point name or purpose>"` 2. Collect Source Context - Summarize purpose, exports, key patterns. - Folders: list structure, highlight key modules. - Functions/APIs: capture signature, parameters, return values, error handling. 3. Analyze Dependencies - Build dependency view up to depth 3, track visited nodes to avoid loops. - Categorize: imports, function calls, services, external packages. - Exclude external systems or generated code. 4. Synthesize - Overview (purpose, language, high-level behavior). - Core logic, execution flow, patterns. - Error handling, performance, security considerations. - Improvements or risks discovered during analysis. 5. Create Documentation …
Read the whole file at its exact version.
How to install
mdr add codeaholicguy/ai-devkit/document-code@sha256:9e0e4108e486726fThe line at the top of this page pins the label git:20260511.ff9d3bb, 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_czdjgoknpzqrvjjq)
2 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 2 versions of this file, between May 9, 2026 and May 11, 2026, about one every 2 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260511.ff9d3bb latest | 2026-05-11 | ff9d3bb | 4,140 B | A | view · diff |
| git:20260509.b959610 | 2026-05-09 | b959610 | 2,480 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 (4140 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
codeaholicguy/ai-devkit · 1,656 stars · license Apache-2.0 · pushed 2026-11-03 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_czdjgoknpzqrvjjq GET https://markdownregistry.com/api/v1/resolve?ref=codeaholicguy/ai-devkit/document-code GET https://markdownregistry.com/api/v1/blob/9e0e4108e486726fe8f43e7c2360875a4cdda23864cad9c82414fa338bd1ba34
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 codeaholicguy/ai-devkit
Every file in codeaholicguy/ai-devkit