docs:update-docs

Analyze code diffs to generate prioritized documentation update tasks.

Updated Apr 6, 2026
One-click install
npx skills add https://github.com/luicabref97/sushi-jungle-web --skill docs-update-docs-luicabref97
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs:update-docs
Source: https://github.com/luicabref97/sushi-jungle-web/tree/main/.agents/skills/docs-update-docs
Command: npx skills add https://github.com/luicabref97/sushi-jungle-web --skill docs-update-docs-luicabref97

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Projects accumulate undocumented code changes and outdated guides because maintainers lack a reliable workflow to detect documentation-impacting changes and produce targeted, maintainable updates that avoid bloat and drift.

Core Features & Use Cases

  • Change-driven discovery: Analyze uncommitted changes or the latest commit to locate documentation-impacting edits across docs/, README files, JSDoc, and API documentation.
  • Multi-agent orchestration: Coordinate analysis agents and tech-writer agents to generate, group, and prioritize documentation tasks for simple and complex changes.
  • Quality and index updates: Identify index documents and module READMEs that require updates, produce targeted content, and run quality review agents to verify examples, links, and style.
  • Use Case: After a refactor that reorganizes exports and alters public APIs, produce module README updates, API reference changes, and a prioritized checklist for documentation maintainers.

Quick Start

Run the docs:update-docs skill to analyze local changes and generate prioritized documentation tasks and suggested file updates.

Frequently Asked Questions about docs:update-docs

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

FAQPage Schema
How do I automate documentation updates for local code changes?

To automate documentation updates for local code changes, you analyze uncommitted diffs or the latest commit to locate documentation-impacting edits. The system coordinates analysis and tech-writer agents to generate targeted, maintainable updates for README files, JSDoc, and API references.

How does multi-agent documentation generation work for code refactoring?

Multi-agent documentation generation works by orchestrating analysis agents to extract documentation-impacting changes and tech-writer agents to group, prioritize, and produce content. This ensures module README updates and API reference changes are accurately maintained after a refactor.

What is change-driven documentation discovery and when do I need it?

Change-driven documentation discovery is the process of analyzing uncommitted changes or the latest commit to locate edits requiring doc updates. You need it when projects accumulate undocumented code changes and outdated guides to prevent documentation bloat and drift.

Can I use this to update JSDoc and generated API documentation together?

Yes, you can use this to update JSDoc and generated API documentation together. It applies to repositories with docs directories, README files, JSDoc, or generated API documentation, grouping tasks by documentation area to coordinate comprehensive updates.

What's the best way to audit documentation quality after updating code?

The best way to audit documentation quality after updating code is to run quality review agents that verify examples, links, and style. This ensures targeted content generation avoids bloat and drift while maintaining accurate index documents and module READMEs.

Does this documentation update workflow work with uncommitted local changes?

Yes, this documentation update workflow works with both uncommitted local changes and the latest commit. It performs discovery of documentation infrastructure and extracts documentation-impacting changes to produce prioritized tasks and suggested file updates.