mcpp-docs-style

A writing guide for English and Simplified Chinese documentation, README files, and long design records. It defines a precise, professional style and lists wording and heading patterns to avoid.

In plain words
What is it for?
Use it when writing or editing documentation, README files, or external sections of design records. It does not apply to code comments or commit messages.
Why use it?
It helps keep project documentation consistent and factual, so readers can find accurate information without interpreting conversational or exaggerated wording.

Skill for Claude CodeCodex

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/mcpp-community/mcpp/mcpp-docs-style
Any agent
npx skills add mcpp-community/mcpp --skill mcpp-docs-style
Clone the repo
git clone --depth 1 https://github.com/mcpp-community/mcpp

Made for: Claude Code, Codex.

Per session 76 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,065 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00076 $0.02065
Opus 5 $0.00038 $0.01033
Sonnet 5 $0.00015 $0.00413
Haiku 4.5 $0.00008 $0.00206

Measured yesterday against content hash 6daefa774316, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

mcpp-docs-style scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.agents/skills/mcpp-docs-style/SKILL.md · 155 lines

How it starts

The opening of the file, as written. The whole thing — 155 lines — stays where its author put it; the contents beside it link to each section on GitHub.

mcpp 文档风格规范

适用范围

docs/**(含 docs/zh/**)、README.md.agents/docs/** 的对外部分。

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

一、总原则

文档是参考资料,不是博客,也不是聊天记录。判据只有一条:

一位不认识作者、只想解决自己问题的工程师,能不能在最短时间内 拿到准确的事实,并且不会误以为某个说法比实际更随意或更绝对。

由此得到三条可执行的规则:陈述、精确、克制。

二、标题

标题一律是名词短语或陈述句,不使用疑问句、不使用口语片段。

疑问句标题把「读者已经知道自己在找什么」这个前提丢掉了 —— 目录里一列问句, 读者要先把每个问句翻译成主题才能定位。

不采用 采用
一段话讲完 概述
打什么由谁决定 打包内容的决定依据
哪些 .cppm 会被发布 发布的接口单元
消费者的构建会检查什么 消费端的构建检查
怎么消费 消费方式
老版本 mcpp 拿到这种包会怎样 旧版本 mcpp 的行为
为什么两者都不许裁剪 两个集合不可裁剪的原因
这些说法验证到哪一步、在哪台机器上 验证范围
The whole idea in one paragraph Overview
What decides what gets packed What determines the package contents
Consuming one Consuming a package
What you may rely on, and what changes Stability guarantees

「…的原因」「…的依据」「…的范围」是把 why 型标题转成名词短语的常用形。 保留 why 本身,去掉疑问语气。

三、词汇

不采用的类别

  1. 网络用语与口语:搞定、干活、坑、真香、翻车、打脸、一把梭、白给、 凉了、炸了、神器、黑科技、敲黑板、划重点。
  2. 拟人与比喻性行话:姊妹篇、腿(fat package 的一份产物)、travel(源码 「旅行」)、picky、happy path 的中文直译。技术术语本身可以是比喻 (rpath、sysroot),但不要新造比喻
  3. 填充语:其实、说白了、简单来说、众所周知、显然、当然、值得一提的是。 如果一件事显然,就不必说;如果不显然,「显然」会让读者怀疑自己。
  4. 含糊的程度词:很快、非常、极其、基本上、差不多。用数字或范围替代 —— 「2.42×」「64.77s」「四个平台中的三个」。

人称

默认不使用第二人称。写动作的对象,不写「你」。

  • 不采用:你可以在 mcpp.toml 里写 …
  • 采用:在 mcpp.toml 中声明 …

例外:教程体文档可以使用第二人称,因为那里读者正在跟着做。教程体是 列出来的,不是推断的:00-getting-started.md01-examples.md04-build-from-source.md。其余全部按参考文档处理。

引用 mcpp 自身输出的部分不受此限:did you mean 'x86_64-linux-musl'?your toolchain : … 是程序打印的原文,逐字复现是要求,不是文风问题。 检查脚本因此会先剔除行内代码段再判定。

四、句式

  • 陈述句优先。 命令式仅用于操作步骤(「运行 mcpp build」)。
  • 一句话一个事实。 从句套从句的长句拆开。
  • 不使用反问。「难道不应该……吗?」没有信息量。
  • 不使用感叹号。
  • 破折号克制使用:插入语用逗号或括号;破折号留给「随后是对前半句的 重述或收束」这一种用法。

五、断言的强度必须与证据相符

这是本规范里最实质的一条,也是最容易违反的一条。

证据 允许的表述
跑过、有输出 「实测」「测量得到」,并给出数字或报错原文
读代码推断 「按 X 的实现」「由 Y 决定」
未验证 「未验证」「尚无测试覆盖」—— 必须写出来

Read the full file on GitHub · 155 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 155 lines · 76 tokens per session scan A 6daefa774316

Subscribe to this mod's changes

mcpp-docs-style is a skill published in the GitHub repository mcpp-community/mcpp (114 stars, last pushed yesterday), licensed Apache-2.0. It adds 76 tokens to every session and 2,065 once invoked, about $0.0004 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other skills, from other repositories

readable-cpp

Readable C/C++/Rust/CUDA code rules inspired by The Art of Readable Code. Use when writing, reviewing, or refactoring C, C++, Rust, or CUDA code. Enforces short functions, flat control flow, clear naming, readable structure, and idiomatic patterns.

crazyguitar/cppcheatsheet · 63 tokens

cpp

Comprehensive C/C++ programming reference covering everything from C11-C23 and C++11-C++23, system programming, CUDA GPU computing, debugging tools, Rust interop, and advanced topics. Use for: C/C++ questions, C/C++ interview preparation, modern language features, RAII/memory management, templates/generics, CUDA…

crazyguitar/cppcheatsheet · 107 tokens

mcpp-style-ref

为 mcpp 项目应用 Modern/Module C++ (C++23) 编码风格。适用于编写或审查带模块的 C++ 代码、命名标识符、组织 .cppm/.cpp 文件,或用户提及 mcpp、module C++、现代 C++ 风格时。.

Sunrisepeak/mbun · 73 tokens

mbun-runtime-debugging

调试 mbun 运行时测试失败/崩溃时用。提供仓库实测可用的定位配方——选二进制、单文件跑测、gdb 抓 backtrace、按 API 定位源码、常见坑排查清单、何时跳过。凡处理 bun 测试跑不过/段错误/hang/断言失败,先读本 skill 再动手,避免每个 task 重复摸索拖慢。.

Sunrisepeak/mbun · 109 tokens

dev-process

在本仓开发任何改动前用。规定 issue 先行的开发流程,按 bugfix / 优化 / 新功能分流;新功能须经 issue 充分讨论并在 .agents/docs 落地设计方案;衔接 tdd-workflow 与本体验证 / 测试 / CI / PR 规范。开发前先读本 skill。.

Sunrisepeak/mbun · 82 tokens

issue-reporting

向本仓提交 issue / 发起讨论时用。规定一份好问题反馈的 SOP——软件/版本、报错信息、初步分析、相关资料,并去除本地隐私(用户名/token 等替换)。凡要创建 issue、反馈 bug、发起讨论,先读本 skill 再动手。.

Sunrisepeak/mbun · 75 tokens