Skip to content
Skills Library
Programming · Writing

module-readme

/module-readme

维护模块 README 与版本记录。用户说「文档」「更新 README」时使用。

Repository
ai-gates ↗
Licence
MIT
Last repository change
22.10.2026

Assessment and security

86/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability21 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content25 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
2
Scripts
0
HTML comments
0
URLs in SKILL.md
0
Deprecation

No signals detected. Repository changed on 22.10.2026, without references to retired models or APIs.

Licence

MIT, open: use and modify while retaining author attribution.

What it does and when to use it

维护模块 README 与版本记录。用户说「文档」「更新 README」时使用。

Original author description

维护模块 README 与版本记录。用户说「文档」「更新 README」时使用。

How it works

  1. PM 门禁(硬停)
  2. 车道
  3. 模型路由 + 子窗
  4. 何时须本岗(与 [readme-dispatch.md](../references/readme-dispatch.md) 一致)
  5. Checklist
  6. README 必含
  7. 禁止
Original SKILL.md headings · 54 lines, 161 words
SKILL.md preview
---
name: module-readme
description: 维护模块 README 与版本记录。用户说「文档」「更新 README」时使用。
---

# 文档

首行:**`[docs]`**。日常入口:[agent-entry-route.md](../references/agent-entry-route.md);争议/recovery:[CORE.md](../CORE.md)

## PM 门禁(硬停)

用户直接叫本岗、且**本轮尚无** `[PM]` YAML + **你下一步** 时:**不得**改 README;须同条先 `[PM]` 判车道并输出白话 **你下一步**,再切本岗。只读咨询(不改文件)→ 不阻塞。

## 车道

| 车道 | 本岗 |
| --- | --- |
| Express | 通常 skip;可选程序员一行版本 |
| Direct | 通常 `dev-one-liner`(程序员一行);≥2 文件或结构改动 → `readme: docs` 本岗 |
| Standard/Full | PM 标 `readme: docs` 时**须**本岗;`dev-one-liner` 由程序员一行完成 |

## 模型路由 + 子窗

`readme: docs` 时本岗**必须子窗**(便宜快速模型);禁止主窗切 `[docs]` 后直接改 README 结构。`dev-one-liner` 随实现子窗。细则 → [model-routing.md](../references/model-routing.md)。

## 何时须本岗(与 [readme-dispatch.md](../references/readme-dispatch.md) 一致)

满足**任一**即 `docs`:

- ≥2 个业务文件改动
- 新/改 public API
- 新增回归场景(须同步 project-context 索引)
- README 结构或「调试与回归」节须更新

仅 **1 文件、无新 API、无新回归** → `dev-one-liner`,程序员自更。

## Checklist

1. **须有 CR 结论**(Express=自检清单)且无 blocker;否则只写「待代码审核」
2. Read 真实代码 + **现有** README + `.cursor/project-context.md`(写前先检索,见 [execution-discipline.md](../references/execution-discipline.md) §复用四问)
2.1 **能少写/不写**:一行版本记录能说清则**不**扩结构/原理章;禁止复述已有运作原理
3. 版本记录含:目的、影响、CR 状态、验证状态、未验证风险(如 Standard 无图谱须写明影响面未图谱验证)
4. 新增回归场景 → 同步 `.cursor/project-context.md` 索引 + `.ai-gates/regression-index.yaml`
5. 不把 static-checked 写成 runtime-validated
6. 默认不改业务代码

## README 必含

概述、约束、文件结构、运作原理、调试/回归说明、版本迭代记录。

版本条目格式:`| 日期 | 版本 | feat/fix/refactor: 范围 — 原因与影响 |`

## 禁止

- CR 有 blocker 写最终完成 / 凭文件名猜测模块行为

细节 → [references/state-machine.md](../references/state-machine.md)
Files in this package (2)
  • SKILL.md 3 KB
  • agents/openai.yaml 1 KB

Versions

The database has no other skills named module-readme.

Database snapshot: 13.11.2026 · package version a36e532e772a (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 95readme
    When the user wants to create or update a README.md file for a project. Also use when the user says 'write readme,' 'create readme,' 'document this project,' 'project documentation,' or asks for he...
  • 96create-readme
    Use when generating or updating a project README.md or CHANGELOG.md.
  • 100readme-generator
    从零分析项目并生成中文 README.md。当用户说「生成 README」「写 README」「创建 README」「帮我写项目文档」「给项目加个 readme」「项目说明文档」时使用此 skill。 也适用于用户说「这个项目还没有 README」「帮我补一个项目说明」等场景。
  • 100rc-readme
    Writes or refreshes a project README from evidence in the codebase. Use to generate or update one. Do not use for API specs or changelogs.
  • 100documentation-engineer
    Technical documentation expert for creating clear, comprehensive documentation. Use when user asks to write docs, create README, or document code.
  • 100generating-docs
    Generates README.md and DESIGN.md scaffolds by analyzing module structure. Use when creating documentation templates for new modules. Automatically triggered at module creation.

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.