mcpp-docs-style SKILL.md skillA

mcpp-docs-style from mcpp-community/mcpp is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add mcpp-community/mcpp/mcpp-docs-style@git:20260908.9a71c9a

Pins git:20260908.9a71c9a in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
mcpp-community/mcpp
Path
.agents/skills/mcpp-docs-style/SKILL.md
Versions recorded
2
Latest version
git:20260908.9a71c9a, committed Sep 8, 2026
First version recorded
Aug 17, 2026
Size
31,515 bytes
Repository stars
197
License
Apache-2.0

Use when writing or editing anything under docs/ (English or 简体中文), docs/specs/, README files, or the design records under .agents/docs/ — states which tree a document belongs to, that docs/ is a usage manual for what mcpp has already implemented rather than a design account, the register it is written in (academic, declarative, precise, no emoji, no internet slang), the requirement that a document match the current implementation, the gradient a topic is documented along, the coverage a…

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

# mcpp 文档规范

本规范回答六个问题:**这份文档的归属**(第一节)、**为什么要有这一章**(第二节)、
**怎么写**(第三至七节)、**它必须对得上什么**(第八节)、
**它欠多少覆盖**(第十节)、**怎么评审它**(第十四节)。

最核心的一条在第一节:**用户文档是已实现功能的使用手册**,不是设计说明。

代码注释与 commit message **不受本规范约束** —— 它们的读者、篇幅与目的都不同,
那里允许并鼓励叙述「为什么」以及实测过程。

## 一、文档的归属:三棵树与各自的准入判据

一份文档属于哪棵树,由**读者**决定,不由篇幅或主题决定。

| 树 | 读者 | 准入判据(问自己这一句) | 稳定性 |
|---|---|---|---|
| `docs/**` | 手上有任务的人 | 手上有这个任务的人,没有它做不完 | 增量;旧拼法留作别名 |
| `docs/specs/**` | 对着机制做实现的人:索引作者、下游工具、贡献者 | **没有它,两个独立实现会不一致** | 编号 + 版本 + 状态机 |
| `.agents/docs/**` | 做这次改动的人,以及以后问「为什么是这样」的人 | 做了一个决定,理由否则会丢 | **落地即不可变** |
| `.agents/skills/**` | 照着做的人或 agent | 这是**步骤**,不是解释 | 随流程变 |

### 用户文档是**已实现功能的使用手册**

这是本规范最核心的一条。

> `docs/**` 服务的是**要把事情做成的用户**。它写 mcpp **已经实现**的东西怎么用,
> 不写这些东西**为什么被设计成这样**,也不写**什么设计了、什么还没设计**。

不写进用户文档的四类内容,它们全部属于 `.agents/docs/`:

1. **设计理由与取舍** ——「为什么是一个机制而不是两个」「这个边界由模型的性质
   决定而不是本文档的雄心」。
2. **被否掉的替代** ——「三种替代方案都不能去掉它」「某原语写出来又撤回了」。
3. **路线图与设计状态** ——「计划中」「将来会支持」「已设计未实现」「下一步是」。
   用户文档里一个能力只有两种状态:**能用**(带版本下界)与**不支持**(一句话)。
4. **实现内幕** —— 除非用户不知道它就会用错。

**判据(逐段问一遍):把这一段删掉,读者还能不能正确地用?**

- 能 → 删掉,或移进设计记录。
- 不能 → 它不是设计论证,是**使用信息**;改写成事实陈述,去掉论证语气。

**边界写成事实,不写成论证。** 「当前边界」一节(第十节要求它必须存在)是一份
清单,不是一段说理:

| 不采用 | 采用 |
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add mcpp-community/mcpp/mcpp-docs-style@sha256:158fe166992260ad

The line at the top of this page pins the label git:20260908.9a71c9a, 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.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_5wsagxrjirjzp5rf.svg)](https://markdownregistry.com/a/art_5wsagxrjirjzp5rf)

3 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 2 versions of this file, between Aug 17, 2026 and Sep 8, 2026, about one every 22 days.

versioncommittedcommitsizeaudit
git:20260908.9a71c9a latest2026-09-08 9a71c9a 31,515 BA view · diff
git:20260817.f2f90942026-08-17 f2f9094 7,100 BA view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (31515 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

GitHub

mcpp-community/mcpp · 197 stars · license Apache-2.0 · pushed 2026-11-05 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_5wsagxrjirjzp5rf
GET https://markdownregistry.com/api/v1/resolve?ref=mcpp-community/mcpp/mcpp-docs-style
GET https://markdownregistry.com/api/v1/blob/158fe166992260ad2108bfad285262197f163ea6dcccc3b5861ff7dcbc8bf5d3

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 mcpp-community/mcpp

mcpp-contributing SKILL.md skill
mcpp-community/mcpp · .agents/skills/mcpp-contributing/SKILL.md · Use when contributing to the mcpp project — submitting bug fixes, new features, code optimizations, documentation…
git:20261028.e0b1133 · audit A · 197 stars
mcpp-release SKILL.md skill
mcpp-community/mcpp · .agents/skills/mcpp-release/SKILL.md · Use when releasing a new version of mcpp — bumps version, creates tag, triggers release CI, and monitors until all…
git:20261002.1bb5ea3 · audit A · 197 stars
mcpp-usage SKILL.md skill
mcpp-community/mcpp · .agents/skills/mcpp-usage/SKILL.md · Use when helping users install, configure, or use mcpp — the C++23 modular build tool. Covers installation, project…
git:20261023.d5ec182 · audit B · 197 stars

Every file in mcpp-community/mcpp

Browse by kind, by grade A, or by owner.