docs-tidy

Review and synchronize BACKLOG.md, PROGRESS.md, and README.md files.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the maintenance of project documentation by automating the cleanup and synchronization of backlog, progress, and README files, ensuring clarity and relevance.

Core Features & Use Cases

  • Documentation Audit and Update: Performs automated review of BACKLOG.md, PROGRESS.md, and README.md to ensure items are current and accurately reflect project status.
  • Milestone and Report Generation: Adds new milestone entries and key PR summaries to progress logs after significant development phases.
  • Use Case: When a project completes a major release, use this Skill to prune completed backlog items, document the milestone in progress, and update the project overview for clear communication.

Quick Start

Initiate the cleanup process by running the documentation maintenance procedure to synchronize, prune, and update project files.

Frequently Asked Questions about docs-tidy

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

FAQPage Schema
How do I automate markdown documentation upkeep after merging pull requests?

Automating markdown documentation upkeep involves reviewing BACKLOG.md and README.md to synchronize status updates and prune completed items after pull request merges, ensuring project files accurately reflect the current development state.

What is the best way to update project documentation after a major release?

Updating project documentation after a major release requires pruning completed backlog items, adding milestone entries to progress logs, and refreshing the project overview, maintaining clarity and relevance for clear team communication.

Do I need external dependencies to synchronize project markdown files?

Synchronizing project markdown files requires no external dependencies; the process analyzes documentation natively to audit content, identify outdated entries, and apply status updates without needing additional libraries.

When should I perform a documentation audit for project management?

Perform a documentation audit during project management when reaching significant milestones or after frequent PR merges, ensuring progress logs and backlogs remain synchronized with actual development status.

Can I automate backlog cleanup and progress log generation together?

Automating backlog cleanup and progress log generation together streamlines documentation maintenance by pruning completed backlog items while simultaneously adding milestone entries and key PR summaries to progress files.