skills.rest
quan2005
quan2005COMMUNITY
Explore all skills by this author →
GitHub

docs-maintenance

Enforce documentation updates before commits when code changes alter architecture or behavior.

13|2|Updated Mar 13, 2026
Search Tags:#architecture#documentation#developer workflow#readme#governance#git commit#llms.txt
One-click install
npx skills add https://github.com/quan2005/journal-claw --skill docs-maintenance-quan2005
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-maintenance
Source: https://github.com/quan2005/journal-claw/tree/main/.agents/skills/docs-maintenance
Command: npx skills add https://github.com/quan2005/journal-claw --skill docs-maintenance-quan2005

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill prevents verified code changes from being committed without matching documentation updates. It turns documentation maintenance into a repeatable pre-commit gate so architecture notes, agent instructions, README navigation, and user or developer docs stay consistent with the actual system.

Core Features & Use Cases

  • Pre-commit documentation gate: Decides whether docs must be updated based on verified stories, design impact, actual diffs, and explicit skip conditions.
  • Targeted multi-document maintenance: Updates AGENTS.md, ARCH.md, DESIGN.md, README.md, llms.txt, user guides, and developer guides only when the change scope requires it.
  • Strict editing protocols: Enforces incremental edits, semantic versioning for AGENTS.md, fixed ARCH.md structure, synchronized README and llms.txt navigation, and reader-specific boundaries for user versus developer documentation.
  • Use case: When a verified story changes architecture, workflow conventions, or user-visible behavior, use this Skill to determine exactly which documentation files need revision and keep them in the same commit as the code.

Quick Start

Ask the AI to use the docs-maintenance skill before git commit to verify whether the current verified story and diff require updates to AGENTS.md, ARCH.md, README.md, llms.txt, or related documentation.

Frequently Asked Questions about docs-maintenance

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

FAQPage Schema
How do I ensure documentation updates are included before a git commit?▼

To ensure documentation updates are included before a git commit, use a pre-commit gate that checks verified stories and code diffs to enforce required incremental edits to architecture, design, and user guides.

What is the best way to keep AGENTS.md and llms.txt synchronized with code changes?▼

The best way to keep AGENTS.md and llms.txt synchronized is applying strict editing protocols that enforce semantic versioning and synchronized navigation updates within the same commit as the implemented behavior.

How do I know which docs to update when modifying architecture or workflow conventions?▼

To know which docs to update when modifying architecture or workflow conventions, evaluate the actual code diff and verified story impact to determine targeted maintenance needs for AGENTS.md, ARCH.md, DESIGN.md, README.md, or developer guides.

Can I skip documentation maintenance if the code change is not user-visible?▼

You can skip documentation maintenance if the verified story and code diff explicitly meet skip conditions without introducing architecture, design, convention, workflow, or user-visible changes.

Does documentation governance require fixed structural rules for ARCH.md and README.md?▼

Documentation governance requires fixed structural rules for ARCH.md and synchronized README navigation, enforcing reader-specific boundaries between user versus developer documentation to maintain system consistency.

Related Skills

Explore More Software Engineering Skills→
luzhenqianluzhenqian
149

commit-msg

Analyze staged git diffs and generate Conventional Commits compliant messages.

Community
Intermediate
kriscendobotkriscendobot
3

cherry-pick-followup

Apply specific git commits across branches to synchronize documentation and configuration files.

Community
Basic
TalonT-OrgTalonT-Org
5

verify-diag

Validate architecture diagrams against source code for component and connection accuracy.

Official
Advanced
kanopikanopi
16

documentation-generator

Generate Markdown/HTML documentation from code for Drupal and WordPress projects.

Official
Intermediate