technical-documentation SKILL.md skillA
technical-documentation from jpeetz/agent-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add jpeetz/agent-skills/technical-documentation@v1.0.0Pins v1.0.0 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- jpeetz/agent-skills
- Path
skills/documentation-content/technical-documentation/SKILL.md- Versions recorded
- 3
- Latest version
- v1.0.0, committed Oct 28, 2026
- First version recorded
- Aug 31, 2026
- Size
- 30,621 bytes
- Repository stars
- 15
- License
- none declared
Use this skill when creating, maintaining, or auditing technical documentation — READMEs, ADRs, API docs, runbooks, onboarding guides, changelogs, knowledge bases, and AI agent context files (AGENTS.md/CLAUDE.md). Covers documentation- driven development, OpenAPI generation, markdown best practices, and completeness/accuracy audits. For all major agentic platforms.
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
# /technical-documentation — Create, maintain, and audit technical # documentation: READMEs, ADRs, API docs, runbooks, onboarding guides, # changelogs, knowledge bases, and AI-agent-facing context files. # Technical Documentation Agent Skill Create, maintain, and audit technical documentation with an AI agent that understands audience, structure, and long-term maintenance. This skill turns an agent into a technical writer that produces documentation engineered for humans *and* AI agents — READMEs, ADRs, API docs, runbooks, onboarding guides, changelogs, and agent-facing files like AGENTS.md. --- ## Quick Reference | Document Type | Purpose | Key Audience | Lifecycle | |---|---|---|---| | 📘 **README** | Project entry point | New contributors, evaluators | Updated with every release | | 🏛️ **ADR** | Record architectural decisions | Future maintainers | Immutable once accepted | | 🔌 **API Docs** | Describe endpoints/schemas | API consumers, integrators | Updated with every API change | | 🚨 **Runbook** | Incident response procedures | On-call engineers | Reviewed after every incident | …
Read the whole file at its exact version.
How to install
mdr add jpeetz/agent-skills/technical-documentation@sha256:4d103a63ed027686The line at the top of this page pins the label v1.0.0, 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_mqj3xk6mgqphekkt)
4 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 3 versions of this file, between Aug 31, 2026 and Oct 28, 2026, about one every 29 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| v1.0.0 latest | 2026-10-28 | e711966 | 30,621 B | A | view · diff |
| v1.0.0 | 2026-09-14 | 5722530 | 30,870 B | A | view · diff |
| v1.0.0 | 2026-08-31 | 945bdcc | 30,869 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 (30621 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
jpeetz/agent-skills · 15 stars · license none declared · pushed 2026-10-28 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_mqj3xk6mgqphekkt GET https://markdownregistry.com/api/v1/resolve?ref=jpeetz/agent-skills/technical-documentation GET https://markdownregistry.com/api/v1/blob/4d103a63ed02768645c713397eb53db6da1fd1476fc53309047414b54a9e0029
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 jpeetz/agent-skills
Every file in jpeetz/agent-skills