doc-standards SKILL.md skillA
doc-standards from pillumina/ascend-sleuth is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add pillumina/ascend-sleuth/doc-standards@git:20261009.3640a77Pins git:20261009.3640a77 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- pillumina/ascend-sleuth
- Path
skills/doc-standards/SKILL.md- Versions recorded
- 5
- Latest version
- git:20261009.3640a77, committed Oct 9, 2026
- First version recorded
- Oct 8, 2026
- Size
- 11,116 bytes
- Repository stars
- 5
- License
- MIT
写或改任何给人读的文档之前，先定类型、再套骨架、最后过反例清单。覆盖 docs/ 六层、 README、定位报告、case/reference 词条、EV 卡、postmortem、PR body、skill 正文。给出九类 文档的固定小节与顺序、跨类型硬规则、状态标注、图与外部讨论的摆放位置，并分清哪几条能写成 检查、哪几条只能人审。用户要写新文档、重写一篇结构散掉的文档、或问「这篇文档该怎么组织 / 该有哪些节」时使用。.
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
# 分类型文档规范 > `docs/spec/writing-norms.md` 管**词句层**：一句话怎么说、哪个词不能用。本规范管**篇章层**：这是哪类文档、该有哪些节、按什么顺序、多长、图放哪、状态怎么标。两篇互指，不互为副本。 > 本仓的层名、路径与已有的机械门在 `references/repo-anchors.md`，换项目只改那一份。 ## 解决的问题 同一层的两篇文档，一篇把结论放在开头，一篇把结论埋在第五节；一篇写了「不做什么」，一篇没写；已落地、蓝图、已否决三种状态混在同一节里，读者读不出哪个是真的。 三处代价一起出现：读者每读一篇都要重新判断哪节才是结论；作者每动笔都要重新发明一次大纲；评审只能说「读起来累」，说不出该改哪里。 这里给的是结构契约。类型定了，骨架就定了，谁写都一样。 ## 三步 **第一步，定类型。** 到下面的类型表里找一行。判不准时问两件事：读者是在**学**还是在**做**（学 → 导览、机制说明；做 → 操作指南、计划）；这份内容让人**理解**什么，还是让人**据以判断**（理解 → 导览、机制说明、复盘；判断 → 规范条文、决策记录、提案）。 **第二步，套骨架。** 到 `references/type-catalog.md` 找那一类，照它列的小节顺序写。列出来的小节一个不落、顺序不改；某一节确实没有内容，就写一句「无」并说明为什么没有，不要删节——读者分不清「没有」和「忘了写」。 **第三步，过反例清单。** 提交前对着 `references/anti-patterns.md` 逐条自查。那份清单里的每条都是这个仓库真实出现过的写法，不是通用文风建议。 ## 类型表 | 类型 | 读者读完能做什么 | 本仓写点 | |---|---|---| | 导览 | 知道这套系统在做什么，接下来该读哪篇 | `docs/README.md`、`docs/demo-walkthrough.md` | | 规范条文 | 判断某个设计或改动合不合规 | `docs/spec/` | | 机制说明 | 说清某个机制怎么运作，边界在哪 | `docs/mechanism/` | | 操作指南 | 按步骤把某件事做出来 | `docs/guide/` | | 计划 | 知道下一步做什么，什么时候算做完 | `docs/plan/` | | 决策记录 | 知道当初为什么这样选，还能不能推翻 | `docs/adr/` | | 提案 | 判断这个改动该不该做，代价是什么 | `proposals/` | | 复盘 | 知道一次事件里发生了什么，下次怎么避免 | `postmortems/`、`traces/*.report.md` | …
Read the whole file at its exact version.
How to install
mdr add pillumina/ascend-sleuth/doc-standards@sha256:e64e7babb58ce03dThe line at the top of this page pins the label git:20261009.3640a77, 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_cqgr2hxiwqqlzg52)
2 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 5 versions of this file, between Oct 8, 2026 and Oct 9, 2026, more than one a day.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20261009.3640a77 latest | 2026-10-09 | 3640a77 | 11,116 B | A | view · diff |
| git:20261008.63504c7 | 2026-10-08 | 63504c7 | 10,394 B | A | view · diff |
| git:20261008.77061a2 | 2026-10-08 | 77061a2 | 10,235 B | A | view · diff |
| git:20261008.0c86d61 | 2026-10-08 | 0c86d61 | 9,936 B | A | view · diff |
| git:20261008.dcc7b54 | 2026-10-08 | dcc7b54 | 9,931 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 (11116 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
pillumina/ascend-sleuth · 5 stars · license MIT · pushed 2026-10-31 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_cqgr2hxiwqqlzg52 GET https://markdownregistry.com/api/v1/resolve?ref=pillumina/ascend-sleuth/doc-standards GET https://markdownregistry.com/api/v1/blob/e64e7babb58ce03d2f91d52e02c72e34b1b152a33fc94b9a05a04da4e683238c
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.