briefbound-readme-optimization SKILL.md skillA

briefbound-readme-optimization from ccdawn/codex-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add ccdawn/codex-skills/briefbound-readme-optimization@git:20260929.25d03f6

Pins git:20260929.25d03f6 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
ccdawn/codex-skills
Path
skills/engineering/briefbound-readme-optimization/SKILL.md
Versions recorded
3
Latest version
git:20260929.25d03f6, committed Sep 29, 2026
First version recorded
Sep 17, 2026
Size
4,144 bytes
Repository stars
6
License
MIT

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.

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

# 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-development-cleanup`(验证后的真实残留)、`briefbound-router` 或 BLOCKED。

## 统一调用契约

- 只处理 README/文档面;不匹配时回 `briefbound-router` 或更具体 owner,复合任务不吞其他 owner。
- 用户可见内容默认中文、保留技术字面量;Route Out 仅以 Briefbound task contract 为准;有自然闸门(需用户裁决、批准或被阻塞)时末行 `下一步建议: <一个具体动作>`,否则声明继续已授权工作。

## 章节骨架(按类型裁剪)

通用顺序:标题+一行描述 → 徽章(可选、不超过 4 枚)→ 简介(是什么/为什么,3 行内)→ 安装 → 使用(可复制命令+最小示例)→ 目录结构(仅复杂仓)→ 贡献(仅开源协作仓)→ 许可证。

- **agent 技能包**:加技能目录(名称+一句话)、安装命令、路由/链动入口说明(参照本仓库 README 模式)。
- **脚本/工具合集**:每个入口脚本一段用法(命令、输入输出、一个示例);清单中不存在的脚本不写。
- **网页/应用项目**:加截图位、技术栈表、本地开发步骤。
- **研究仓库**:加环境、数据、复现命令、结果引用。
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add ccdawn/codex-skills/briefbound-readme-optimization@sha256:5475661f0c067636

The line at the top of this page pins the label git:20260929.25d03f6, 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_fvzguicehljcgzl3.svg)](https://markdownregistry.com/a/art_fvzguicehljcgzl3)

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

Versions

The registry has recorded 3 versions of this file, between Sep 17, 2026 and Sep 29, 2026, about one every 6 days.

versioncommittedcommitsizeaudit
git:20260929.25d03f6 latest2026-09-29 25d03f6 4,144 BA view · diff
git:20260922.a8d85912026-09-22 a8d8591 4,095 BA view · diff
git:20260917.6f08a812026-09-17 6f08a81 4,090 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 (4144 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

ccdawn/codex-skills · 6 stars · license MIT · pushed 2026-10-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/5475661f0c067636887dc1db5c235175966656771d3622d9b8c9f1ba4a064370

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 ccdawn/codex-skills

AGENTS.md AGENTS.md file
ccdawn/codex-skills · AGENTS.md
git:20260813.dec1d14 · audit A · 6 stars
CLAUDE.md CLAUDE.md file
ccdawn/codex-skills · CLAUDE.md
git:20260813.dec1d14 · audit A · 6 stars
briefbound-pengyou SKILL.md skill
ccdawn/codex-skills · skills/companion/briefbound-pengyou/SKILL.md · Use when 用户开启闲聊会话——点名「陪我聊聊」「随便聊聊」「聊两句」「朋友模式」,或明确想没目的地东聊西聊。AI 像朋友一样主动找话题、带节奏、说不同意见,而不是顺着用户聊。工作、编码、任务型请求不加载本技能;用户情绪低落想倾诉时转…
git:20261021.9e6ce32 · audit A · 6 stars
briefbound-score-loop SKILL.md skill
ccdawn/codex-skills · skills/competition/briefbound-score-loop/SKILL.md · Use when repeated work is governed by an explicit metric, active baseline, candidate search, promotion rule…
git:20260929.25d03f6 · audit A · 6 stars
briefbound-creative-toolbox SKILL.md skill
ccdawn/codex-skills · skills/creative/briefbound-creative-toolbox/SKILL.md · Use when the user wants non-obvious but useful ideas, concept invention, naming, reframing, variation, selection…
git:20260916.292b0ac · audit A · 6 stars
briefbound-diagram-design SKILL.md skill
ccdawn/codex-skills · skills/creative/briefbound-diagram-design/SKILL.md · Use when creating or redrawing structured diagrams such as architecture, flowcharts, sequences, ER/UML, timelines or…
git:20260916.ed1d50d · audit A · 6 stars
briefbound-adr SKILL.md skill
ccdawn/codex-skills · skills/engineering/briefbound-adr/SKILL.md · Use when the user asks to record a settled architecture or technology decision as an ADR(写 ADR、记录决策、技术选型定案存档), or a…
git:20260929.20085bb · audit A · 6 stars
briefbound-api-contract SKILL.md skill
ccdawn/codex-skills · skills/engineering/briefbound-api-contract/SKILL.md · Use when a change touches an external contract surface - REST/GraphQL endpoints, request/response schemas, DB schema…
git:20260920.280b6d2 · audit A · 6 stars
briefbound-autonomous-collaboration-loop SKILL.md skill
ccdawn/codex-skills · skills/engineering/briefbound-autonomous-collaboration-loop/SKILL.md · Use when the user explicitly enables an automated same-project multi-thread development loop that keeps peer Codex…
git:20260929.25d03f6 · audit A · 6 stars
briefbound-bdd-tdd-development SKILL.md skill
ccdawn/codex-skills · skills/engineering/briefbound-bdd-tdd-development/SKILL.md · Use when an already-defined new behavior or high-risk implementation contract needs a failing test before…
git:20260916.292b0ac · audit A · 6 stars
briefbound-bug-review SKILL.md skill
ccdawn/codex-skills · skills/engineering/briefbound-bug-review/SKILL.md · Use when an observed bug, correctness regression, failing test, build failure, abnormal behavior, or unresolved root…
git:20260916.292b0ac · audit A · 6 stars
briefbound-code-structure-guard SKILL.md skill
ccdawn/codex-skills · skills/engineering/briefbound-code-structure-guard/SKILL.md · Use when active development or explicit refactoring has concrete code-structure risk: a source file is accumulating…
git:20260916.292b0ac · audit A · 6 stars

Every file in ccdawn/codex-skills

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