guide-updater

Original：🇨🇳 Chinese

Translated

1 scriptsChecked / no sensitive code detected

Use this tool when the user explicitly requests "update project guide", "sync guide", or "deposit insights into the guide". It saves newly generated reusable writing insights from conversations to the project guide file in real time, ensuring consistent terminology, stable structure, verifiability and reproducibility. The guide file path must be specified when invoking.

2installs

Sourcehuangwb8/chineseresearchlatex

Added on2026-03-02

NPX Install

npx skill4agent add huangwb8/chineseresearchlatex guide-updater

SKILL.md Content (Chinese)

View Translation Comparison →

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

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

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"

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

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

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

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

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