technical-documentation SKILL.md skillA
technical-documentation from magnus919/agent-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add magnus919/agent-skills/technical-documentation@git:20260804.6f67a34Pins git:20260804.6f67a34 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- magnus919/agent-skills
- Path
technical-documentation/SKILL.md- Versions recorded
- 3
- Latest version
- git:20260804.6f67a34, committed Aug 4, 2026
- First version recorded
- Jul 12, 2026
- Size
- 4,044 bytes
- Repository stars
- 162
- License
- MIT
Create and review technical documentation, including READMEs, agent-facing instructions, API references, and CLI help. Use when documentation must help someone complete real work. Do not use for marketing copy, brand messaging, or long-form editorial content.
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 Methodology Technical documentation is the interface between a tool and its user. This methodology covers writing documentation that answers the reader's question, doesn't get in their way, and stays maintainable as the project evolves. ## The Technical Writer's Domain | You own | You don't own | |---------|--------------| | API documentation — endpoint references, parameters, examples | Editorial and long-form narrative content — owned by the editorial function, outside this skill's scope | | README authorship — project overview, quickstart, configuration | Brand messaging and marketing copy — that's the brand designer | | CLI documentation — help text, usage patterns, exit codes | Code architecture decisions — that's the software-architecture-analysis | | Agent-facing docs — AGENTS.md, skill documentation | Project roadmap and product vision — that's the product manager | | Reference documentation — config files, troubleshooting, architecture | Performance optimization guidance — that's the systematic-debugging / SRE | …
Read the whole file at its exact version.
How to install
mdr add magnus919/agent-skills/technical-documentation@sha256:98b3932422cbd27bThe line at the top of this page pins the label git:20260804.6f67a34, 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_xp7k3scwfaf5ypla)
4 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 3 versions of this file, between Jul 12, 2026 and Aug 4, 2026, about one every 11 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260804.6f67a34 latest | 2026-08-04 | 6f67a34 | 4,044 B | A | view · diff |
| git:20260803.0223e2b | 2026-08-03 | 0223e2b | 3,844 B | A | view · diff |
| git:20260712.306b1bd | 2026-07-12 | 306b1bd | 3,698 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 (4044 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
magnus919/agent-skills · 162 stars · license MIT · pushed 2026-11-01 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_xp7k3scwfaf5ypla GET https://markdownregistry.com/api/v1/resolve?ref=magnus919/agent-skills/technical-documentation GET https://markdownregistry.com/api/v1/blob/98b3932422cbd27b6ae04de8bf35efeeea82bcf9b6aef9111a3f4ff2156194b8
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 magnus919/agent-skills
Every file in magnus919/agent-skills