docs

Align project documentation with current codebase and metadata.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Sync project documentation with the actual state of the codebase, ensuring references stay accurate without altering the author's voice.

Core Features & Use Cases

  • Inventory and verify documentation files (README.md, ROADMAP.md, AGENTS.md, CHANGELOG.md, docs/, todo.txt, LICENSE) against project metadata and code.
  • Detect stale references, outdated versions, and mismatched ROADMAP items; suggest surgical fixes without rewriting content.
  • Maintain alignment during iterative changes, ensuring quickstart and governance docs stay current in production workflows.

Quick Start

Scan the repository documentation to identify stale references and apply surgical fixes that preserve the author's tone.

Frequently Asked Questions about docs

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

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

Detect and fix stale references in documentation by inventorying files like README.md, ROADMAP.md, and CHANGELOG.md against current codebase metadata. The process verifies version stamps and applies surgical edits that preserve the author's voice while reporting staleness with audit-ready changes.

What is the best way to sync project documentation with code changes?

Sync project documentation by verifying version stamps and checking project-wide references against actual code state. This approach identifies mismatched ROADMAP items and outdated content, suggesting surgical fixes rather than rewriting entire files to maintain alignment during iterative changes.

Can I update outdated README references without altering the author's writing style?

Yes, you can update outdated README references without altering the author's writing style. The system enforces surgical edits that preserve the original voice and tone, applying minimal targeted fixes to correct mismatched content across project manifests and documentation files.

How do I audit a repository for stale references and outdated version stamps?

Audit a repository for stale references by scanning documentation files and associated manifests against project metadata and code. This generates audit-ready reports detailing outdated version stamps, mismatched ROADMAP items, and content inconsistencies across sources like AGENTS.md and LICENSE.

Does this documentation syncing approach work for production governance files like AGENTS.md?

Yes, this documentation syncing approach works for production governance files like AGENTS.md. It maintains alignment during iterative changes by verifying that quickstart and governance docs stay current with actual codebase state in production workflows.