메뉴
为代码库子模块/子目录建立模块级 README 文档体系，并通过 CLAUDE.md 建立导航索引。 当用户提到以下任一情况时触发：代码库太大 AI 翻代码费上下文、给子模块加文档、 创建 README 索引、模块文档化、代码库导航、子系统文档、需要理解某个文件夹的作用、 代码组织结构文档、AI 查看代码时上下文溢出。也适用于任何需要为代码库建立结构化 文档导航的场景，无论语言是 Python/JavaScript/MATLAB/C++/Go 等。
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
Academic text polisher and humanizer for Chinese and English research writing. Removes AI-like patterns while preserving factual accuracy. Use when polishing academic text, reducing AI-generated patterns in papers/theses, improving naturalness of research writing while maintaining data integrity, or enhancing scholarly tone without fabricating facts. Supports both Chinese (中文) and English academic texts with configurable tone, field-specific terminology, and strict factuality controls.
Use when an agent has produced a task version, implementation, document, plan, research result, or other deliverable that must be independently accepted, rejected, scored, or sent back for iteration.
Use when the user asks to learn, understand, explain, introduce, or thoroughly understand a concept; says they do not understand; reads or interprets papers; wants to use a method in a paper, project, or experiment; needs prerequisites, learning order, learner-level adaptation, Chinese-first external learning resources, staged resource packs, Wikipedia/Baidu Baike concept baselines, document-anchored teaching, or a learning path for a goal; organizes AI answers or rough notes into knowledge-base prose; or explores research implications.
Research and write Chinese knowledge-base documents for technical, scientific, academic, product, or conceptual topics. Use when the user wants a readable beginner-to-intermediate learning article, encyclopedia-style reference, tutorial-style concept document, Feishu knowledge-base draft, or a rewrite of AI-like fragmented notes into a complete reliable document with sources, diagrams, formulas, examples, and visual planning.
当用户要求"周总结""本周总结""上周总结""整理周报"等任务时使用。本技能从飞书云空间扫描每日 docx 文档，参考既有周报风格，生成新的周总结并写回飞书 weekly 文件夹。
Codex-native Academic Research Skills suite for deep research, academic paper writing, manuscript review, full research-to-paper pipelines, and experiment planning or validation. Use when the user asks for deep research, literature review, systematic review, meta-analysis, research question refinement, academic paper drafting, paper revision, citation or integrity checks, reviewer simulation, peer review, editorial decision letters, research-to-paper workflows, experiment execution planning, statistical interpretation, or human study protocol support. Also use for Claude-style ARS command aliases such as /ars-plan, ars-plan, /ars-outline, /ars-abstract, /ars-lit-review, /ars-citation-check, /ars-disclosure, /ars-format-convert, /ars-revision-coach, /ars-revision, /ars-reviewer, /ars-mark-read, /ars-unmark-read, and /ars-full. This skill vendors ARS role prompts, references, templates, and shared handoff schemas under ars/.
| name | readme-wiki |
| description | 为代码库子模块/子目录建立模块级 README 文档体系，并通过 CLAUDE.md 建立导航索引。 当用户提到以下任一情况时触发：代码库太大 AI 翻代码费上下文、给子模块加文档、 创建 README 索引、模块文档化、代码库导航、子系统文档、需要理解某个文件夹的作用、 代码组织结构文档、AI 查看代码时上下文溢出。也适用于任何需要为代码库建立结构化 文档导航的场景，无论语言是 Python/JavaScript/MATLAB/C++/Go 等。 |
为代码库中的子模块/子目录建立标准化的 README 文档，并通过项目根目录的 CLAUDE.md
（或 AGENTS.md、README.md）建立导航索引。解决 AI 在理解代码逻辑时翻遍大量文件、
上下文溢出的问题。
扫描当前代码库，识别所有子目录（排除 .git、.claude、node_modules、归档目录、
纯数据目录、临时目录等）。列出：
判断标准（满足任一即需要）：
不需要 README 的情况：
对每个需要文档的目录，创建或增强 README.md，必须包含以下章节：
# 目录名 — 一句话职责
## 简介
一句话说明这个模块是做什么的，在整个系统中的位置。
## 职责边界
- **做**：...
- **不做**：...
## 核心函数/文件清单
| 函数/文件 | 输入 | 输出 | 说明 |
|-----------|------|------|------|
| `funcA.m` | `x` (n维向量) | `y` (标量) | 核心计算入口 |
| `funcB.m` | 无 | `cfg` (结构体) | 配置读取 |
## 数据流
用 ASCII 图或文字描述谁调用这个模块、这个模块调用谁：
input/ --→ calculate/ --→ coefficient/ --→ calculate_strength/ --→ limit/
## 注意事项 / 常见坑
- 陷阱1：...
- 陷阱2：...
内容要求：
在项目根目录的 CLAUDE.md（如果存在）或 README.md 中，添加"模块文档导航"章节：
## 模块文档导航
当你需要理解某个子系统的逻辑时，**优先查阅对应模块的 README.md**，
而非直接翻阅代码。
| 想了解什么 | 查阅文档 | 一句话说明 |
|-----------|---------|-----------|
| 想了解强度计算链路 | `arc/calculate_strength/README.md` | 应力计算→极限应力→安全系数 |
| 想了解约束体系 | `arc/limit/README.md` | 行星/平行/全局三级约束 |
| ... | ... | ... |
### 数据流速查
input/ --→ calculate/ --→ coefficient/ --→ calculate_strength/ --→ limit/
如果项目同时有 CLAUDE.md 和 AGENTS.md，两者必须保持同步更新。
完成初稿后，重新审视每个 README：
删除过度文档化的 README，只保留有真正信息增量的文档。
在 CLAUDE.md 的"工程规则"部分添加：
模块文档（README）随代码同步更新：修改模块接口、函数签名、数据流或约束逻辑时， 必须同步更新对应 README。过时的文档比没有文档更有害。
README.md（首字母大写）readme.md（小写），替换为标准的 README.mdarchive/、legacy/ 等），这些已在 CLAUDE.md 中标注CLAUDE.md 或 README.md 作为索引载体；如果没有，
会建议用户先创建