document-project SKILL.md skillA
document-project 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-project@git:20260429.47a6786Pins git:20260429.47a6786 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-project/SKILL.md- Versions recorded
- 1
- Latest version
- git:20260429.47a6786, committed Apr 29, 2026
- Size
- 5,153 bytes
- Repository stars
- 48
- License
- MIT
Generate comprehensive, professional project documentation structures including README, ARCHITECTURE, USER_GUIDE, DEVELOPER_GUIDE, and CONTRIBUTING files. Use when the user requests project documentation creation, asks to "document a project", needs standard documentation files, or wants to set up docs for a new repository. Adapts to Python/Go projects and OpenSource/internal contexts.
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
# Project Documentation Generator Generate complete, professional documentation structures for software projects. Automatically adapts content and structure based on project language (Python/Go), context (OpenSource/internal), and existing files. ## Core Documentation Files Always generate these five core files: 1. **README.md** - Project overview, quick start, badges 2. **ARCHITECTURE.md** - System design, components, data flow 3. **USER_GUIDE.md** - Usage examples, configuration, troubleshooting 4. **DEVELOPER_GUIDE.md** - Development setup, testing, contribution workflow 5. **CONTRIBUTING.md** - Contribution guidelines, code standards, PR process ## Workflow ### 1. Context Detection Before generating docs, detect: - **Language**: Scan for `go.mod`, `pyproject.toml`, `requirements.txt`, `setup.py` - **Project type**: Check for `Dockerfile`, `terraform/`, `k8s/`, AI/ML indicators - **Existing docs**: Identify what already exists to avoid duplication - **License**: Detect from LICENSE file or ask user - **Context**: Determine if OpenSource or internal based on repo structure ### 2. Ask Clarifying Questions Ask user ONE question at a time to fill gaps: …
Read the whole file at its exact version.
How to install
mdr add jjmartres/ai-coding-agents/document-project@sha256:e382c278dfd50a98The line at the top of this page pins the label git:20260429.47a6786, 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_la3xnrpmpszhii4m)
3 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Apr 29, 2026.
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 (5153 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_la3xnrpmpszhii4m GET https://markdownregistry.com/api/v1/resolve?ref=jjmartres/ai-coding-agents/document-project GET https://markdownregistry.com/api/v1/blob/e382c278dfd50a98753f0045a6a791612bcd90325b2d39859226cef8d529727a
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.