# Build Readme

> 基于真实项目事实创建或更新 README；文件缺失或与事实不符时使用，不用于普通文档润色、代码开发或发布。

- Skill: `koco-co/build-readme` (Agent Skill, multi-file: 13 files)
- Install (CLI): `npx skillmds@latest add koco-co/build-readme`
- Raw SKILL.md: https://api.skillmd.com/api/skills/koco-co/build-readme/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- License: MIT
- Author: koco-co (https://skillmd.com/u/koco-co)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/koco-co/build-readme

---


# Outcome

把项目真实能力整理为准确、可维护且通过验证的 GitHub 风格 README。

## Routing

- 没有根目录 `README.md` 时创建；已有时保留事实并更新。
- 已有伴随 README 时按任务范围同步；不存在时不创建。
- 用户明确要求创建、更新或修复 README 且范围可由仓库事实确定时直接实施；仅审查或预览时保持只读。
- 普通文档、代码、发布和仓库主页配置不属于本 Skill；由 `audit-agent-setup` 调用时遵循上层授权范围。

## Steps

1. 读取 `workflows/§01-research.md`，核对入口、安装、使用、验证、限制和资源。
2. 读取 `workflows/§02-preview.md` 与 `templates/readme-preview.template.md`，确定内容、资源、同步文件和外部动作；只有用户要求预览，或存在会改变公开内容、文件范围或外部动作的未决选择时才等待确认。
3. 授权范围明确后读取 `workflows/§03-authoring.md`、`rules/github-style.md` 和 `rules/evidence-and-content.md`，编写 README。
4. 读取 `workflows/§04-validation.md` 与 `checklists/semantic-acceptance.md`，运行校验器并记录渲染或远程检查状态。
5. 读取 `workflows/§05-delivery.md`，报告变更、证据和未验证项。

## Rules

- 只写有仓库证据的能力、命令、版本、兼容性、许可证和链接；保留未提交修改。
- 用户明确要求创建、更新或修复时已授权对应 README 文件的本地编辑；翻译其他文件、生成图片、远程渲染、安装依赖、提交、推送和发布仍需明确授权。