documentation is agent-read markdown (skill) from jnpiyush/agentx: Write effective documentation including inline docs, README structure, API documentation, and code comments. Use when writing README files, documenting APIs, creating architecture decision records, adding inline code documentation, or setting up documentation tooling..
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
> **Purpose**: Write clear, maintainable documentation for code and APIs.
> **Goal**: Self-documenting code, useful comments, comprehensive READMEs.
> **Note**: For implementation, see [C# Development](../../languages/csharp/SKILL.md) or [Python Development](../../languages/python/SKILL.md).
---
## When to Use This Skill
- Writing or updating README files
- Documenting APIs with OpenAPI/Swagger
- Creating architecture decision records (ADRs)
- Adding inline code documentation
- Setting up documentation tooling
## Prerequisites
- Markdown formatting knowledge
## Decision Tree
```
Documenting something?
+- New project/repo? -> README.md (setup, usage, contributing)
+- Public API?
| +- REST API -> OpenAPI/Swagger spec
| - Library -> XML docs / docstrings on all public members
+- Architecture decision? -> ADR (docs/artifacts/adr/ADR-NNN.md)
+- Complex logic?
| +- WHY it works this way -> Code comment
| - HOW to use it -> Doc comment / docstring
+- Code self-explanatory?
| - Yes -> No comment needed (good naming > comments)
- Inline comment?
+- Explains WHY (business rule, workaround) -> Keep it
- Explains WHAT (obvious from code) -> Remove it
```
…
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.
GET https://markdownregistry.com/api/v1/artifacts/art_avvgyuexq3xqyed7
GET https://markdownregistry.com/api/v1/resolve?ref=jnpiyush/agentx/documentation
GET https://markdownregistry.com/api/v1/blob/1e48fd0e6a75c00c866c05c0a2b14faf2ffa6259bd6096107cf96516d4a2bf8a
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.
jnpiyush/agentx · .github/skills/ai-systems/agent-observability/SKILL.md · Instrument LLM agents with tracing, metrics, and evaluation telemetry. Use when adding OpenTelemetry GenAI semantic…
jnpiyush/agentx · .github/skills/ai-systems/ai-agent-development/SKILL.md · Build production-ready AI agents with Microsoft Foundry and Agent Framework. Use when creating AI agents, selecting LLM…
jnpiyush/agentx · .github/skills/ai-systems/ai-evaluation/SKILL.md · Use when evaluating AI quality, safety, completeness and cost with held-out tasks, executable graders, calibrated…
jnpiyush/agentx · .github/skills/ai-systems/ai-safety-and-red-teaming/SKILL.md · Defend LLM systems against prompt injection, jailbreaks, data exfiltration, and unsafe output. Covers input/output…
cooneycw/claude-power-pack · .claude/skills/documentation/SKILL.md · Generate C4 architecture diagrams as GitHub-renderable Mermaid, and PowerPoint slides. Use to update docs, or draw a c4…
alexander-danilenko/cortex-ai-skills · skills/documentation/SKILL.md · ALWAYS invoke for any task involving docstrings, JSDoc/TSDoc, or REST API documentation — even when the request seems…
