doc-it

Scan local files to patch stale READMEs, API docs, and CHANGELOGs.

1|2|Updated May 27, 2026
One-click install
npx skills add https://github.com/dividedby/skills --skill doc-it
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-it
Source: https://github.com/dividedby/skills/tree/main/skills/engineering/doc-it
Command: npx skills add https://github.com/dividedby/skills --skill doc-it

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill eliminates documentation rot by ensuring your README, API docs, and CHANGELOG stay perfectly aligned with your actual source code, preventing the common issue of stale or misleading project information.

Core Features & Use Cases

  • Automated Sync: Automatically generates or patches reference documentation based on current code exports and configurations.
  • Drift Detection: Audits ADRs and CONTEXT.md files to report where documentation has drifted from the implementation without modifying sensitive decision records.
  • Use Case: Run this after a major refactor to update your API documentation and README to reflect new module names and entry points without manual editing.

Quick Start

Use the doc-it skill to scan the current repository and apply updates to all stale reference documentation.

Frequently Asked Questions about doc-it

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

FAQPage Schema
How do I automatically sync my README and API docs with my source code?

To sync README and API docs with source code, this skill scans local files to identify and patch stale documentation based on current code exports. It operates in an automated patching mode to generate or update reference files without requiring network connectivity.

What is the best way to detect documentation drift after a major refactoring?

Detecting documentation drift after a major refactoring is handled by a report-only audit mode. This mode scans Architectural Decision Records and context files to report where documentation has diverged from the implementation without modifying sensitive decision records.

Can I automatically update a CHANGELOG based on local code changes?

Yes, you can update a CHANGELOG based on local code changes. The skill scans local files to synchronize project reference documentation by identifying and patching stale CHANGELOGs deterministically during its automated patching operations.

Does documentation synchronization require network access or external dependencies?

Documentation synchronization does not require network access or external dependencies. The skill performs deterministic documentation updates entirely through local file system access, ensuring updates are applied without any network dependency.

How do I audit ADRs and CONTEXT.md files without modifying them?

To audit ADRs and CONTEXT.md files without modifying them, use the report-only audit mode. This mode specifically scans architectural decision records and context files to report documentation drift while leaving the sensitive decision records untouched.