guide-updater

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

项目指南更新器

Project Guide Updater

将对话中新产生的可复用写作洞见实时沉淀到项目指南文件，保持术语口径一致、结构稳定、可检验与可复现。

Save newly generated reusable writing insights from conversations to the project guide file in real time, ensuring consistent terminology, stable structure, verifiability and reproducibility.

使用方式

Usage

调用此技能时，必须在参数中指定指南文件路径：

/guide-updater --guide-path <路径>

或自然语言形式：

"更新项目指南（路径：projects/MyProject/项目指南.md）"
"把这些内容同步到指南文件 docs/写作指南.md"

When calling this skill, you must specify the guide file path in the parameters:

/guide-updater --guide-path <路径>

Or in natural language form:

"Update the project guide (path: projects/MyProject/项目指南.md)"
"Sync these contents to the guide file docs/写作指南.md"

先决条件

Prerequisites

每次更新前快速自检：

不新增新的
```
##
```
级标题；只在既有小节/列表中"融入"新增要点。
不改动既有标题文本、编号、顺序；不为"整理美观"重排大量内容。
新增内容默认写成 1 条或少量 bullet，紧贴相邻条目的写法与语气。
涉及事实/文献：只写可核验信息；无法核验则标注"待核验"，不要编造详细信息。

Quick self-check before each update:

Do not add new
```
##
```
level headings; only "integrate" new points into existing sections/lists.
Do not modify existing heading text, numbering, or order; do not rearrange large amounts of content for "neat presentation".
New content should be written as 1 or a small number of bullets by default, following the writing style and tone of adjacent entries.
For involved facts/literature: only write verifiable information; mark as "to be verified" if unverifiable, do not make up detailed information.

抽取"原子洞见"

Extract "Atomic Insights"

将用户表达拆成若干条"可落笔"的要点，每条只包含一个主张/规则/写法。
为每条要点附 1 句"写进指南的目的"（例如：统一口径/防评审质疑/可复现/风险控制）。

Split user expressions into several "writable" points, each containing only one claim/rule/writing specification.
Attach 1 sentence of "purpose of inclusion in the guide" to each point (e.g.: unify standards, avoid review queries, ensure reproducibility, risk control).

选择融入位置

Choose Integration Location

需要更细的落点规则时，先读

skills/guide-updater/references/guide-structure-map.md

再动手。

写作原则/禁区/句式 →
```
## 写作哲学
```
术语、缩写、大小写、核心概念定义 →
```
## 命名与术语
```
方法链条、验证口径、评估指标 →
```
## 基本原理
```
范式定位、对照坐标系、差异化要点 →
```
## 文献综述与创新性
```
具体写到哪一节（文档结构映射） →
```
## 落点清单
```
评审问答口径 →
```
## 评审专家可能的问题及回答
```
风险与对策 →
```
## 研究风险
```
"可核验事实锚点"（源码、参数、流程） →
```
## 附录
```

不确定放哪：优先放到"最能减少未来写作返工"的位置；仍不确定就先问用户"更希望作为写作哲学/技术路线/风险控制哪一类沉淀？"再改文件。

When more detailed placement rules are required, read
```
skills/guide-updater/references/guide-structure-map.md
```
before operation.
Writing principles/prohibitions/sentence patterns →
```
## Writing Philosophy
```
Terminology, abbreviations, capitalization, core concept definitions →
```
## Naming and Terminology
```
Method chains, verification standards, evaluation indicators →
```
## Basic Principles
```
Paradigm positioning, reference coordinate system, differentiation points →
```
## Literature Review and Innovativeness
```
Specific section for placement (document structure mapping) →
```
## Placement List
```

Review Q&A standards →

## Possible Questions from Review Experts and Answers

Risks and countermeasures →
```
## Research Risks
```
"Verifiable fact anchors" (source code, parameters, processes) →
```
## Appendix
```

If unsure of placement: prioritize the position that can "minimize future writing rework"; if still unsure, first ask the user "Do you prefer to deposit this as a type of writing philosophy/technical route/risk control?" before modifying the file.

以最小补丁写入

Write with Minimal Patches

只做"增量补丁"：新增 1--3 条 bullet 或在既有 bullet 末尾补 1 句澄清。
不新开大段长文；如果洞见很大，先拆成多个 bullet 分散落在对应小节。
与已有术语保持一致（参考项目既有术语表）。

Only make "incremental patches": add 1--3 bullets or add 1 clarification sentence at the end of existing bullets.
Do not add large sections of long text; if the insight is large, split it into multiple bullets and place them in corresponding sections separately.
Keep consistent with existing terminology (refer to the project's existing glossary).

更新后校验

Post-update Verification

运行

python skills/guide-updater/scripts/validate_guide.py <指南文件路径>

（或手动确认关键

##

标题仍存在）。

搜索是否意外新增
```
##
```
级标题或引入"另起炉灶"的新结构。

Run

python skills/guide-updater/scripts/validate_guide.py <guide file path>

(or manually confirm that key

##

headings still exist).

Check if
```
##
```
level headings are accidentally added or new "independent" structures are introduced.

Resources

目录	用途
`scripts/`	校验 `项目指南.md` 是否保持关键结构与必要标题
`references/`	记录结构映射与落点规则，避免反复判断放置位置

Directory	Purpose
`scripts/`	Verify whether `项目指南.md` maintains key structure and necessary headings
`references/`	Record structure mapping and placement rules to avoid repeated judgment of placement positions