update-docs

Compare codebase state against documentation and update outdated sections.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/brianbartilet/harqis-work --skill update-docs-brianbartilet
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/brianbartilet/harqis-work/tree/main/.claude/skills/update-docs
Command: npx skills add https://github.com/brianbartilet/harqis-work --skill update-docs-brianbartilet

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill addresses the challenge of maintaining up-to-date and accurate documentation for complex codebases, reducing discrepancies and improving clarity.

Core Features & Use Cases

  • Automated Documentation Drift Checking: Compares codebase state against existing documentation sections to detect inconsistencies.
  • Selective Content Updating: Guides targeted edits to synchronize docs with current project status.
  • Use Case: When a new app component is added or an existing one is modified, run this Skill to review and update the related README sections or other documentation files automatically.

Quick Start

Ask the AI to review and correct the README to reflect the latest project structure and components.

Frequently Asked Questions about update-docs

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

FAQPage Schema
How do I detect documentation drift in my codebase?

Documentation drift is detected by comparing the live codebase state against existing documentation sections to find inconsistencies. This process identifies where docs no longer mirror the real project structure.

How do I automatically update my README to reflect current project components?

You can automatically update a README by running an analysis that checks app inventory, workflows, and system configurations against current code. It then guides selective content edits to synchronize the documentation.

What is the best way to synchronize project documentation with live code analysis?

The best way to synchronize documentation is using live code analysis to enforce consistent, validated updates. This approach ensures docs accurately reflect the current codebase structure and system configurations.

Can I selectively update only the outdated sections in my project documentation?

Yes, you can selectively update outdated sections by targeting specific edits that synchronize docs with the current project status. This avoids rewriting entire files and focuses only on drifted content.

Does documentation sync work for complex codebases with multiple workflows and agents?

Yes, documentation sync works for complex codebases by handling checks across app inventory, workflows, agents, and system configurations. It ensures accuracy regardless of project complexity.

When should I avoid automated documentation drift detection?

You should avoid automated drift detection when the codebase is rapidly changing mid-development and docs are intentionally deferred. It is best suited for enforcing consistency once project components stabilize.