briefbound-readme-optimization skillA
briefbound-readme-optimization is agent-read markdown (skill) from ccdawn/codex-skills: Use when the user asks to create, rewrite, or improve a repository README(优化 README、补仓库文档、开源准备、仓库简介), or a repo lacks a usable README before handoff or release; analyzes manifests and source facts first, then produces an audience-appropriate Chinese-first README where every command and claim is traceable..
Indexed from public GitHub and served as immutable, content-addressed versions. Install it pinned to an exact SHA-256 with the mdr CLI, and every file is verified against the hash recorded here before it reaches your agent. The deterministic audit below grades the latest version, and the same file always earns the same grade.
What the file says
# Briefbound Readme Optimization ## 目标 以仓库事实为据,产出或改进"读者不读源码即可上手"的中文优先 README。按项目类型裁剪章节,绝不编造命令、依赖或功能。 ## Briefbound task contract - Context Boundary: 目标仓库的清单文件(package.json、pyproject.toml、go.mod、Cargo.toml、installer 脚本等)、目录结构、现有 README 与文档、LICENSE、git 远程与语言统计;不改代码逻辑。 - Output Contract: README.md(多语仓含 README.en.md)+ 逐节变更说明 + 事实溯源表(每条命令/功能 ↔ 来源文件)。 - Allowed Action: 读写 README 与文档文件;读取仓库任意文件取证;不执行安装、不改源码语义。 - Success Evidence: 安装与用法逐条可溯源且与清单一致;章节按类型模板完整;新读者不读源码可完成安装与首次运行。 - Stop Condition: 仓库无可用事实源、要求与事实冲突、或需要虚构功能才能满足。 - Route Out: 原任务 owner、`briefbound-diagram-design`(架构配图)、`briefbound-plain-talk`(行文风格)、`briefbound-router` 或 BLOCKED。 ## 统一调用契约 - 只处理 README/文档面;不匹配时回 `briefbound-router` 或更具体 owner,复合任务不吞其他 owner。 - 用户可见内容默认中文、保留技术字面量;Route Out 仅以 Briefbound task contract 为准;有自然闸门(需用户裁决、批准或被阻塞)时末行 `下一步建议: <一个具体动作>`,否则声明继续已授权工作。 ## 章节骨架(按类型裁剪) 通用顺序:标题+一行描述 → 徽章(可选、不超过 4 枚)→ 简介(是什么/为什么,3 行内)→ 安装 → 使用(可复制命令+最小示例)→ 目录结构(仅复杂仓)→ 贡献(仅开源协作仓)→ 许可证。 - **agent 技能包**:加技能目录(名称+一句话)、安装命令、路由/链动入口说明(参照 briefbound-skills 仓库 README 模式)。 - **脚本/工具合集**:每个入口脚本一段用法(命令、输入输出、一个示例);清单中不存在的脚本不写。 - **网页/应用项目**:加截图位、技术栈表、本地开发步骤。 - **研究仓库**:加环境、数据、复现命令、结果引用。 …
Read the whole file at its exact version.
How to install
mdr add ccdawn/codex-skills/briefbound-readme-optimization@git:20260922.a8d8591mdr add ccdawn/codex-skills/briefbound-readme-optimization@sha256:cbe65c30764f80f5Pin to a label to follow the author's releases, or to a sha256 to freeze the exact bytes forever. Either way the resolved hash is written to mdr.lock, and mdr install reproduces it on any machine.
[](https://markdownregistry.com/a/art_fvzguicehljcgzl3)
1 badge views in 30 days
Versions
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260922.a8d8591 latest | 2026-09-22 | a8d8591 | 4,095 B | A | view · diff |
| git:20260917.6f08a81 | 2026-09-17 | 6f08a81 | 4,090 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 (4095 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
ccdawn/codex-skills · 6 stars · license MIT · pushed 2026-09-22 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_fvzguicehljcgzl3 GET https://markdownregistry.com/api/v1/resolve?ref=ccdawn/codex-skills/briefbound-readme-optimization GET https://markdownregistry.com/api/v1/blob/cbe65c30764f80f57fd69e41104244f954de04fca3854c7413dc71f4ea44a7c8
Your agent 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.