guide-updater

Updates living guideline documents with conversational insights via incremental, verified patches.

2.6k|247|Updated Feb 12, 2024

Search Tags:#documentation #terminology #version-control #project-guidelines #guide-updater #writing-consistency #structure-validation

Ready to run

npx skills add https://github.com/huangwb8/ChineseResearchLaTeX --skill guide-updater

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: guide-updater
Source: https://github.com/huangwb8/ChineseResearchLaTeX/tree/main/skills/guide-updater
Command: npx skills add https://github.com/huangwb8/ChineseResearchLaTeX --skill guide-updater

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill helps teams automatically capture and embed conversations into a living project guidelines document, ensuring terminology consistency and structural stability while enabling verifiable, incremental updates.

Core Features & Use Cases

Real-time guideline consolidation: turn dialogue insights into auditable updates without disrupting existing structure.
Incremental patching: add 1-3 bullets per update, preserving the flow of the guide.
Verification & governance: ensures structure remains intact via a validation script before publishing.

Quick Start

Use the guide-updater to push insights into your guidelines:

/guide-updater --guide-path projects/MyProject/项目指南.md

Frequently Asked Questions about guide-updater

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I update project guidelines from conversations without breaking the document structure?▼

To update project guidelines from conversations without breaking structure, apply incremental patches that add 1-3 bullets per update and introduce no new headings. The guide-updater enforces these constraints and runs a validation script to verify structural integrity before publishing.

What is the best way to maintain terminology consistency in living project documentation?▼

Maintaining terminology consistency in living project documentation is achieved by extracting actionable insights from team conversations and consolidating them into the guide. This approach enforces writing consistency and validates the document structure before any changes are committed.

Can I apply incremental patches to markdown guidelines without creating new headings?▼

Yes, you can apply incremental patches to markdown guidelines without creating new headings. The process strictly enforces a requirement where no new headings are allowed, ensuring that existing document flow and structural stability are preserved during updates.

Does the guide-updater validate document structure before publishing updates?▼

Yes, the guide-updater validates document structure before publishing updates. It uses a dedicated validation script called validate_guide.py to ensure that the incremental patches and terminology updates do not disrupt the established project guidelines framework.

How do I push real-time dialogue insights into a team collaboration guidelines document?▼

You push real-time dialogue insights into a team collaboration guidelines document by running the updater with the guide path argument. This extracts conversation insights and consolidates them into living documents as auditable, incremental bullet-point updates.

Are there limitations on how many bullets I can add per update to project guidelines?▼

Yes, there are limitations on how many bullets you can add per update to project guidelines. The patching process restricts updates to 1-3 bullets per iteration to preserve the flow of the guide and ensure verifiable, incremental document consolidation.