
Project Guide Updater
FreeStreamline your project documentation updates.
Free · Opens the source repo
What Project Guide Updater does
The Project Guide Updater skill is designed to facilitate the real-time updating of project guides based on newly generated insights during conversations. It allows users to seamlessly integrate reusable writing insights into their project documentation while maintaining consistent terminology and structure. This skill is particularly useful for teams working on research or documentation-heavy projects, where clarity and consistency are paramount. By specifying the guide file path, users can ensure that their updates are applied directly to the correct document, enhancing collaboration and efficiency.
To use the skill, users must provide the path to the guide file as an argument or in natural language. This ensures that updates are directed appropriately. The skill emphasizes a strict adherence to existing document structures, preventing the introduction of new headings or significant reorganization of content. Instead, it promotes incremental updates, allowing users to add new points as bullet items that align with the existing writing style. This approach minimizes disruption and maintains the integrity of the document.
The Project Guide Updater skill is particularly suited for researchers, technical writers, and project managers who require a reliable method for incorporating new insights into their documentation. It is ideal for environments where collaborative writing and documentation are frequent, ensuring that all contributions are captured and organized effectively. Additionally, the skill includes validation scripts to verify that the guide maintains its essential structure after updates, further ensuring the quality of the documentation.
Overall, this skill enhances the documentation process by allowing for real-time updates while preserving the original structure and intent of the project guides, making it a valuable tool for any team focused on maintaining high-quality documentation.
When to use it
Use this skill when you need to integrate new writing insights into existing project documentation without altering its structure.
When not to use it
This skill is not suitable for creating entirely new documents or for making extensive structural changes to existing guides.
What you can build with it
Updating a Research Guide
A researcher needs to incorporate new findings into their existing research guide without altering its established structure.
Collaborative Documentation
A team of technical writers collaborates on a project and needs a reliable way to integrate new insights into their shared documentation.
Maintaining Consistency in Terminology
A project manager wants to ensure that all updates to the project guide adhere to the established terminology and formatting.
How to install Project Guide Updater
View source1. Install with the skills CLI
npx skills add huangwb8/chineseresearchlatex/research-guide-updater --agent claude-code2. Or install it manually
Download the skill folder and drop it into ~/.claude/skills/ for all projects, or .claude/skills/ to scope it to one repo. Restart Claude Code so it picks up the new skill.
Anthropic's agentic coding CLI, and the reference implementation of Agent Skills. Drop a skill folder into ~/.claude/skills and Claude Code loads it automatically whenever a task matches the skill's description. Claude Code docs
Inside SKILL.md
Written by huangwb8项目指南更新器
BenszAPI 任务工作区
本 Skill 的新任务中间文件统一写入 ./.bensz-api/task-{yyyymmdd-hhmm}-{简短描述}/{skill名}/input|output|log/。同一任务复用一个任务根目录;多 Skill 协作才创建 shared/。正式交付物不写入该目录,历史隐藏目录只允许显式兼容读取、迁移或清理。
与 bensz-collect-bugs 的协作约定
- 当用户环境中出现因本 skill 设计缺陷导致的 bug 时,优先使用
bensz-collect-bugs按规范记录到~/.bensz-skills/bugs/,严禁直接修改用户本地 Claude Code / Codex 中已安装的 skill 源码。 - 若 AI 仍可通过 workaround 继续完成用户任务,应先记录 bug,再继续完成当前任务。
- 当用户明确要求“report bensz skills bugs”等公开上报动作时,调用本地
gh与bensz-collect-bugs,仅上传新增 bug 到huangwb8/bensz-bugs;不要 pull / clone 整个 bug 仓库。
将对话中新产生的可复用写作洞见实时沉淀到项目指南文件,保持术语口径一致、结构稳定、可检验与可复现。
旧名 guide-updater 仅作为 prompt 兼容别名保留;安装新版本时系统级旧目录会被清理。
使用方式
调用此技能时,必须在参数中指定指南文件路径:
/research-guide-updater --guide-path <路径>
或自然语言形式:
- "更新项目指南(路径:projects/MyProject/项目指南.md)"
- "把这些内容同步到指南文件 docs/写作指南.md"
先决条件
每次更新前快速自检:
- 不新增新的
##级标题;只在既有小节/列表中"融入"新增要点。 - 不改动既有标题文本、编号、顺序;不为"整理美观"重排大量内容。
- 新增内容默认写成 1 条或少量 bullet,紧贴相邻条目的写法与语气。
- 涉及事实/文献:只写可核验信息;无法核验则标注"待核验",不要编造详细信息。
抽取"原子洞见"
- 将用户表达拆成若干条"可落笔"的要点,每条只包含一个主张/规则/写法。
- 为每条要点附 1 句"写进指南的目的"(例如:统一口径/防评审质疑/可复现/风险控制)。
选择融入位置
- 需要更细的落点规则时,先读
skills/research-guide-updater/references/guide-structure-map.md再动手。 - 写作原则/禁区/句式 →
## 写作哲学 - 术语、缩写、大小写、核心概念定义 →
## 命名与术语 - 方法链条、验证口径、评估指标 →
## 基本原理 - 范式定位、对照坐标系、差异化要点 →
## 文献综述与创新性 - 具体写到哪一节(文档结构映射) →
## 落点清单 - 评审问答口径 →
## 评审专家可能的问题及回答 - 风险与对策 →
## 研究风险 - "可核验事实锚点"(源码、参数、流程) →
## 附录
不确定放哪:优先放到"最能减少未来写作返工"的位置;仍不确定就先问用户"更希望作为写作哲学/技术路线/风险控制哪一类沉淀?"再改文件。
以最小补丁写入
- 只做"增量补丁":新增 1--3 条 bullet 或在既有 bullet 末尾补 1 句澄清。
- 不新开大段长文;如果洞见很大,先拆成多个 bullet 分散落在对应小节。
- 与已有术语保持一致(参考项目既有术语表)。
更新后校验
- 运行
python skills/research-guide-updater/scripts/validate_guide.py <指南文件路径>(或手动确认关键##标题仍存在)。 - 搜索是否意外新增
##级标题或引入"另起炉灶"的新结构。
Resources
| 目录 | 用途 |
|---|---|
scripts/ | 校验 项目指南.md 是否保持关键结构与必要标题 |
references/ | 记录结构映射与落点规则,避免反复判断放置位置 |
Frequently asked questions about Project Guide Updater
Similar skills
Supabase Docs Authoring
Streamline your Supabase documentation process.
Docs Writer
Streamline your documentation process with precision.
Clinical Case Report
Generate structured medical case presentations.
CrossFrame Suite
Streamline complex workflows for Chinese structural analysis.
Em Dash Expert
Master the em dash for clear, precise writing.
Nature Statistics Reporting
Enhance manuscript statistics for high-impact journal submissions.
