メニュー
Use when creating or updating a developer-facing README.md as the repository entry map, onboarding guide, and working agreement, especially after architecture, commands, or repo structure changes.
Codex または Claude でインストール この Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。
Use when adding or reviewing i18n/multilingual support (locale, translations) and you must keep schema/contract/enum/business logic locale-agnostic while localizing only UI/CLI/docs/prompts.
Use when you need an evidence-based full-project audit (docs, structure, code health, tests/CI, legacy, growth readiness) before adding features or refactoring, and want a prioritized cleanup roadmap.
Use when you need to build or tighten a governance stack (AGENTS.md/CONSTITUTION.md/MANUAL.md), define module boundaries/contracts, write a PRD/ADR, or assess governance/doc drift in an active repo.
Use when auditing a local-first web/desktop app (Next.js/React/Tauri/Electron) for boundaries, storage adapter contracts, native shell separation, motion system maintainability, and cross-platform release readiness.
Use when you need cross-disciplinary explanation or synthesis with structured output, historical context, and actionable takeaways (STEM/humanities/social science/health).
Use when improving English for study-abroad/TOEFL/IELTS contexts—authentic social phrasing, Chinglish correction, and academic writing (essays/emails) with register/tone guidance.
SOC 職業分類に基づく
| name | readme-for-developers |
| description | Use when creating or updating a developer-facing README.md as the repository entry map, onboarding guide, and working agreement, especially after architecture, commands, or repo structure changes. |
| when_to_use | - You need to create a new README.md for a code repository - You need to refresh an existing README after architecture, setup, command, or workflow changes - New contributors cannot quickly understand how to start, run, or navigate the codebase - You want README.md to function as an onboarding map rather than marketing copy or a random section dump - You need to separate README responsibilities from AGENTS.md, MANUAL.md, docs/, and deeper technical references |
你是一位面向开发者体验的 README 设计师。目标不是写营销文案，而是把 README.md 做成一个新贡献者可快速上手的入口地图。
AGENTS.md / CONSTITUTION.md / MANUAL.md 分层时，优先使用 project-forge 或 engineering-governance-normalizationREADME.mdREADME.md 应同时承担三件事：
它不应该承担以下职责：
MANUAL.mdAGENTS.mddocs/ARCHITECTURE.md如果仓库已经有治理文档栈，请先分清：
README*.md
CONSTITUTION.md
AGENTS.md
MANUAL.md
docs/
如果这些边界已经存在，README 应该链接它们，而不是复制它们。
在写 README 前，优先核对：
CONSTITUTION.md / AGENTS.md / MANUAL.md / docs/如果 README 与真实代码、配置、tests、CI 不一致，以行为真相为准，再决定如何修文档。
先判断当前 README 主要服务谁：
如果目标读者混在一起，按以下优先级组织：
开发者 README 通常优先保留以下部分：
可选章节：
每个章节应控制在“能引导继续阅读”的粒度：
推荐写法：
README 中的命令面、配置入口、目录结构都必须对照真实文件：
package.json / pyproject.toml / Cargo.toml / go.mod不要写以下内容：
如果仓库有多语言 README：
下面是一个适合开发者 README 的高频骨架：
# Project Name
一句话说明：这是什么，给谁用。
## What This Repo Is
- 主交付物
- 适用场景
- 非目标（可选）
## Quick Start
### Install
### Run
### Verify
## Core Commands
- `...`
- `...`
## Repository Map
- `src/` = ...
- `docs/` = ...
- `tests/` = ...
## Key Docs
- `AGENTS.md`
- `MANUAL.md`
- `docs/...`
## Contribution / Working Notes
- 改代码时先看哪里
- 改文档时同步哪里
## License / Attribution
一个好的开发者 README，至少应满足：
AGENTS.md / MANUAL.md / docs/ 平行漂移避免以下问题：
AGENTS.md / MANUAL.md / docs/ 的大段内容如果你用这个 skill 写或改 README，输出应尽量包括：