doc-update

Plan documentation updates by analyzing code changes and generating structured file paths.

5|1|Updated Oct 4, 2025
One-click install
npx skills add https://github.com/faroukBakari/trader-pro --skill doc-update-faroukbakari
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-update
Source: https://github.com/faroukBakari/trader-pro/tree/main/.github/skills/doc-update
Command: npx skills add https://github.com/faroukBakari/trader-pro --skill doc-update-faroukbakari

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation teams often struggle to align code changes with accurate, up-to-date documentation. This Skill helps plan comprehensive, self-sufficient documentation updates without editing code.

Core Features & Use Cases

  • Planning: Generate end-to-end plans for updating module docs, root docs, and architecture notes.
  • Gap Analysis: Identify missing documentation, outdated references, and alignment gaps between implementation and docs.
  • Cross-referencing: Map implementation changes to documentation hierarchy and provide absolute file references.
  • Use Case: After a feature rewrite, produce a plan that updates README, API docs, and subsystem docs while preserving versioning considerations.

Quick Start

Align the documentation with recent code changes by generating a new Documentation Update Plan.

Frequently Asked Questions about doc-update

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

FAQPage Schema
How do I plan documentation updates after a code migration?

To plan documentation updates after a code migration, you generate a structured plan that reads referenced files, analyzes impact, and maps changes to the documentation hierarchy with absolute file paths and rationales. This ensures module docs and root docs accurately reflect system evolution.

What is documentation gap analysis for technical writing?

Documentation gap analysis is the process of identifying missing documentation, outdated references, and alignment gaps between implementation and docs. You need it when code changes, feature additions, or policy updates occur to ensure technical writing remains accurate and self-sufficient.

Can I map implementation changes to existing architecture notes without editing code?

Yes, you can map implementation changes to existing architecture notes without editing code. The process reads referenced files and provides absolute file references to cross-reference implementation updates with the documentation hierarchy while preserving versioning considerations.

How do I ensure my README and API docs reflect recent feature additions?

To ensure your README and API docs reflect recent feature additions, generate a documentation update plan that cross-references implementation changes across modules. This produces absolute file paths and rationales to guide updates across all affected technical documentation.

What is the best way to align technical documentation with system evolution?

The best way to align technical documentation with system evolution is performing a documentation audit that identifies alignment gaps between implementation and docs. This generates a structured update plan covering root docs, module docs, and architecture notes without modifying code.

Do I need to manually check every file when coordinating policy change updates?

No, you do not need to manually check every file when coordinating policy change updates. The system reads referenced files automatically, analyzes the impact of changes, and produces a structured plan with rationales to update affected modules and root documentation efficiently.