Document — Update Project Documentation

Audit and synchronize README.md and AGENTS.md with the current codebase.

Updated Dec 26, 2024
One-click install
npx skills add https://github.com/OlympusLaboratories/Demeter --skill document-update-project-documentation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Document — Update Project Documentation
Source: https://github.com/OlympusLaboratories/Demeter/tree/main/larrabeedylan/.claude/skills/document
Command: npx skills add https://github.com/OlympusLaboratories/Demeter --skill document-update-project-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeps project documentation aligned with the current codebase by auditing and updating README.md and AGENTS.md to reflect structure, conventions, and decisions.

Core Features & Use Cases

  • Scope-aware auditing: determines affected directories from recent changes and repo root metadata to target documentation updates.
  • Documentation discovery: reads repo-level conventions (CLAUDE.md, README.md) and per-directory docs to assemble a holistic audit.
  • Guided updates: identifies inconsistencies and produces actionable steps to align docs with code and practices.

Quick Start

Run the skill with an optional path scope like src/ingestion to audit and update documentation for that portion of the repository.

Frequently Asked Questions about Document — Update Project Documentation

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

FAQPage Schema
How do I keep project documentation in sync with my codebase?

To keep project documentation in sync, you can audit and update README.md and AGENTS.md files against the current codebase. This process validates repository conventions and guides targeted updates for affected directories based on recent changes.

What is the best way to audit a README for codebase consistency?

Auditing a README for codebase consistency involves validating it against the current code structure and repo-level conventions. The process reads CLAUDE.md and per-directory docs to identify inconsistencies and produce actionable alignment steps.

How do I update project documentation for a specific directory path?

To update project documentation for a specific directory, run the audit with an optional path argument like src/ingestion. This scopes the documentation synchronization to that portion of the repository, targeting only updates relevant to that directory.

Why does my AGENTS.md file have stale conventions after recent code changes?

Your AGENTS.md file has stale conventions because it was not synchronized after recent code changes. Scope-aware auditing determines affected directories from recent repository changes and identifies inconsistencies to guide targeted documentation updates.

Can I discover and validate repo-level conventions across multiple directories?

Yes, you can discover and validate repo-level conventions by reading CLAUDE.md, README.md, and per-directory docs to assemble a holistic audit. This documentation discovery process enforces consistency across the entire repository structure.