update-documentation

Aligns project documentation with code changes via agent-orchestrated, validated edits.

7|4|Updated Mar 2, 2026
One-click install
npx skills add https://github.com/nklisch/skills --skill update-documentation-nklisch
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-documentation
Source: https://github.com/nklisch/skills/tree/main/plugins/workflow/skills/update-documentation
Command: npx skills add https://github.com/nklisch/skills --skill update-documentation-nklisch

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keep project documentation accurate and aligned with code after feature additions, CLI changes, new config keys, interface modifications, or behavioral fixes. This Skill prevents documentation drift by discovering the project's doc surface, identifying owning documents, and orchestrating precise, validated edits rather than making ad-hoc changes.

Core Features & Use Cases

  • Dynamic doc discovery: Locates docs roots, internal specs, public guides, generated files, memory, and repo-specific skills without assuming fixed paths.
  • Change classification and ownership: Classifies the type of code change and maps which files or doc areas own the change.
  • Agent-orchestrated edits: Plans agent-sized tasks, spawns Sonnet agents with focused prompts that grep and validate before editing, and enforces rules such as not editing generated files and committing changes (do not push).
  • Validation and regeneration: Verifies no stale references remain via grep and triggers regeneration scripts for generated artifacts when needed.
  • Use Case: After adding a new CLI flag and config key, run this orchestrator to update CLI reference, spec, default config, and any derived skills that reference the changed flag.

Quick Start

Run the update-documentation orchestrator after finishing implementation to discover docs, plan targeted edit tasks, spawn Sonnet agents to perform validated edits, and commit the documentation updates.

Frequently Asked Questions about update-documentation

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

FAQPage Schema
How do I update project documentation to match code changes across a repository?

To update documentation to match code changes, this Skill discovers doc roots, classifies code change ownership, spawns Sonnet agents for targeted edits, and verifies with grep to prevent documentation drift across the repository.

What is the best way to prevent documentation drift after adding new CLI commands or config keys?

Preventing documentation drift after adding CLI commands or config keys requires an orchestrator that dynamically locates internal specs and public guides, then applies validated, agent-sized edit tasks to align them with the new code.

Can I automatically update specs and reference pages for modified interface signatures?

Yes, you can automatically update specs and reference pages for modified interface signatures by running this orchestrator, which maps code changes to owning documents and triggers focused edits with regeneration workflows.

Does this documentation update workflow support generated files and memory files?

The documentation update workflow discovers generated files and memory files but enforces rules preventing agents from editing generated artifacts directly, instead triggering regeneration scripts and updating memory files as needed.

How do Sonnet agents perform validated edits on documentation without making ad-hoc changes?

Sonnet agents perform validated edits by receiving focused prompts that require them to grep and verify references before modifying specs or guides, ensuring changes are precise rather than ad-hoc modifications.

What are the limitations of using an orchestrator for repo-maintenance documentation updates?

A limitation of using this orchestrator for repo-maintenance is that it commits documentation changes locally without pushing, requiring manual review and push, and it depends on dynamic discovery to find non-standard doc roots.