update-project-docs

Scan project docs and reconcile them with the filesystem state.

Updated Mar 27, 2026

Search Tags:#documentation #audit #docs #project-management #knowledge-base #lessons-learned

Ready to run

npx skills add https://github.com/jedrecord/hal2026 --skill update-project-docs-jedrecord

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: update-project-docs
Source: https://github.com/jedrecord/hal2026/tree/main/skills/update-project-docs
Command: npx skills add https://github.com/jedrecord/hal2026 --skill update-project-docs-jedrecord

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

After finishing work, project documentation often drifts, leaving stale references, outdated statuses, and missing files. This skill ensures docs stay truthful by scanning, comparing, and updating documentation across the project.

Core Features & Use Cases

Inventory and cross-checks: verify README, CLAUDE.md, task lists, team rosters, and other docs against the actual state.
Consistent updates: fix discrepancies, update status lines, reflect new members, and prune or consolidate outdated entries.
Lessons capture: append timestamped learnings to Learnings.md to prevent repeating mistakes.

Quick Start

Run this skill after completing work to scan project docs, fix discrepancies, and record lessons learned.

Frequently Asked Questions about update-project-docs

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

FAQPage Schema

How do I keep project documentation accurate after a sprint or milestone?▼

Project documentation drift is fixed by scanning and cross-referencing docs like READMEs and task lists against the actual filesystem state. This process updates outdated statuses, prunes stale references, and appends timestamped learnings to keep knowledge bases truthful.

What is the best way to automate a documentation audit for a project knowledge base?▼

A documentation audit is automated by enforcing a repeatable process: inventory existing docs, read their content, cross-reference them with the filesystem, fix discrepancies, and timestamp updates. This ensures project state is accurately reflected across all knowledge base files.

When should I run a documentation update for my project files?▼

You should run a documentation update after completing work such as milestones, sprint finishes, or team reorganizations. These events change the actual project state, requiring a scan to reconcile file trees, status lines, and team rosters in the documentation.

How do I update a README and team roster after a team reorganization?▼

To update a README and team roster after a reorganization, inventory the current docs, cross-reference them with the filesystem, and fix discrepancies. This process reflects new team members, updates file trees, and consolidates outdated entries to maintain an accurate knowledge base.

Does this documentation hygiene process require any external dependencies?▼

No, this documentation hygiene process requires no external dependencies. It operates autonomously to scan project files, cross-reference filesystem state, and apply updates to project management docs without needing additional components or libraries.