documentation-patterns SKILL.md skillA
This file is byte-identical to the first copy the registry indexed. Same content hash, so the same checks give both the same grade.
documentation-patterns from yonatangross/orchestkit is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add yonatangross/orchestkit/documentation-patterns@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
- yonatangross/orchestkit
- Path
src/skills/documentation-patterns/SKILL.md- Versions recorded
- 9
- Latest version
- v1.0.0, committed Sep 29, 2026
- First version recorded
- Jun 20, 2026
- Size
- 3,320 bytes
- Repository stars
- 299
- License
- MIT
Technical documentation patterns for READMEs, ADRs, API docs (OpenAPI 3.1), changelogs, and writing style guides. Use when creating project documentation, writing architecture decisions, documenting APIs, or maintaining changelogs.
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
# Documentation Patterns Templates and opinionated structures for technical documentation -- READMEs, Architecture Decision Records, OpenAPI specs, changelogs, and writing style. Each category has individual rule files in `rules/` loaded on-demand. ## Quick Reference | Category | Rule | Impact | When to Use | |----------|------|--------|-------------| | [README](#readme) | 1 | HIGH | Starting a project, onboarding contributors | | [ADR](#architecture-decision-records) | 1 | HIGH | Recording architecture decisions | | [API Docs](#api-documentation) | 1 | HIGH | Documenting REST APIs with OpenAPI 3.1 | | [Changelog](#changelog) | 1 | MEDIUM | Maintaining release history | | [Writing Style](#writing-style) | 1 | MEDIUM | Any technical writing task | **Total: 5 rules across 5 categories** ## Quick Start ```markdown ## README Skeleton # Project Name Brief description -> Quick Start -> Installation -> Usage -> API -> Config -> Contributing -> License ## ADR Format # ADR-001: Title Status -> Context -> Decision -> Consequences (positive/negative) -> References ## OpenAPI Minimum openapi: 3.1.0 with info, paths, components/schemas, error responses ## Changelog Entry …
Read the whole file at its exact version.
How to install
mdr add yonatangross/orchestkit/documentation-patterns@sha256:dcd0c2cbd03f31caThe 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_ke443ph2f6dkzu6e)
5 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 9 versions of this file, between Jun 20, 2026 and Sep 29, 2026, about one every 13 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| v1.0.0 latest | 2026-09-29 | 105a980 | 3,320 B | A | view · diff |
| v1.0.0 | 2026-09-28 | 220adb4 | 3,330 B | A | view · diff |
| v1.0.0 | 2026-09-23 | de2b771 | 3,333 B | A | view · diff |
| v1.0.0 | 2026-09-20 | 02cb935 | 3,350 B | A | view · diff |
| v1.0.0 | 2026-08-29 | 2aed0b0 | 3,350 B | A | view · diff |
| v1.0.0 | 2026-07-25 | 47b78fb | 3,350 B | A | view · diff |
| v1.0.0 | 2026-07-10 | 10a2d30 | 3,350 B | A | view · diff |
| v1.0.0 | 2026-06-25 | f2bf2d2 | 3,350 B | A | view · diff |
| v1.0.0 | 2026-06-20 | 5700399 | 3,326 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 (3320 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
yonatangross/orchestkit · 299 stars · license MIT · pushed 2026-11-07 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_ke443ph2f6dkzu6e GET https://markdownregistry.com/api/v1/resolve?ref=yonatangross/orchestkit/documentation-patterns GET https://markdownregistry.com/api/v1/blob/dcd0c2cbd03f31ca42a265230aeeedec1fd65648efe252645fe126d7507967b6
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 yonatangross/orchestkit
Every file in yonatangross/orchestkit