documentation SKILL.md skillA
documentation from sutchan/agent-skills-hub is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add sutchan/agent-skills-hub/documentation@git:20261007.ab00264Pins git:20261007.ab00264 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- sutchan/agent-skills-hub
- Path
skills/documentation/SKILL.md- Versions recorded
- 6
- Latest version
- git:20261007.ab00264, committed Oct 7, 2026
- First version recorded
- Aug 20, 2026
- Size
- 1,877 bytes
- Repository stars
- 2
- License
- MIT
编写与维护技术文档。当用户要求“为…写文档”“记录这个”“创建 README”“编写 runbook”“编写入职指南”或需要任何形式的技术写作（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
# Technical Documentation Write clear, maintainable technical documentation for different audiences and purposes. ## Document Types ### README - What this is and why it exists - Quick start (< 5 minutes to first success) - Configuration and usage - Contributing guide ### API Documentation - Endpoint reference with request/response examples - Authentication and error codes - Rate limits and pagination - SDK examples ### Runbook - When to use this runbook - Prerequisites and access needed - Step-by-step procedure - Rollback steps - Escalation path ### Architecture Doc - Context and goals - High-level design with diagrams - Key decisions and trade-offs - Data flow and integration points ### Onboarding Guide - Environment setup - Key systems and how they connect - Common tasks with walkthroughs - Who to ask for what ## Principles 1. **Write for the reader** — Who is reading this and what do they need? 2. **Start with the most useful information** — Don't bury the lede 3. **Show, don't tell** — Code examples, commands, screenshots 4. **Keep it current** — Outdated docs are worse than no docs 5. **Link, don't duplicate** — Reference other docs instead of copying
Read the whole file at its exact version.
How to install
mdr add sutchan/agent-skills-hub/documentation@sha256:364ce7c4367b39d9The line at the top of this page pins the label git:20261007.ab00264, 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_s5f54cjrjg7mirea)
5 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 6 versions of this file, between Aug 20, 2026 and Oct 7, 2026, about one every 10 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20261007.ab00264 latest | 2026-10-07 | ab00264 | 1,877 B | A | view · diff |
| git:20260822.6662c18 | 2026-08-22 | 6662c18 | 1,874 B | A | view · diff |
| git:20260821.3c8c941 | 2026-08-21 | 3c8c941 | 1,862 B | A | view · diff |
| git:20260821.6eecafd | 2026-08-21 | 6eecafd | 1,862 B | A | view · diff |
| git:20260820.53c4f2e | 2026-08-20 | 53c4f2e | 1,821 B | A | view · diff |
| git:20260820.fd063ef | 2026-08-20 | fd063ef | 1,565 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 (1877 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
sutchan/agent-skills-hub · 2 stars · license MIT · pushed 2026-11-06 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_s5f54cjrjg7mirea GET https://markdownregistry.com/api/v1/resolve?ref=sutchan/agent-skills-hub/documentation GET https://markdownregistry.com/api/v1/blob/364ce7c4367b39d940bb7ec09eac837c0840af85d0c6f1b29510244761d0a2c9
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 sutchan/agent-skills-hub
Every file in sutchan/agent-skills-hub