update-docs

Update changelogs, functionality docs, and technical references after feature delivery.

Updated Feb 13, 2025
One-click install
npx skills add https://github.com/davehague/adulting.diy --skill update-docs-davehague
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/davehague/adulting.diy/tree/main/.claude/skills/update-docs
Command: npx skills add https://github.com/davehague/adulting.diy --skill update-docs-davehague

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

After delivering feature work, documentation often lags behind, causing confusion and misalignment across stakeholders. This guide provides a repeatable workflow to update project docs consistently after any significant change.

Core Features & Use Cases

  • Update the changelog with today's changes in a concise, user-centric format.
  • Create or update functionality docs under docs/functionality/ to reflect new behavior.
  • Create or update tech/docs under docs/tech/ to describe implementation details for developers.
  • Optional: refresh CLAUDE.md when project structure or workflow changes.
  • Archive completed plans under docs/plans/completed/ for traceability.

Quick Start

Run the update-docs process after completing a feature to refresh changelogs, functionality docs, tech docs, CLAUDE.md, and archived plans.

Frequently Asked Questions about update-docs

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

FAQPage Schema
How do I update documentation after releasing a new feature?

To update documentation after a feature release, automate the process to refresh changelogs, functionality docs, tech references, and CLAUDE.md simultaneously. This ensures consistency and traceability across all project documentation without manual effort.

What is the best way to maintain changelog and technical docs consistency?

Maintaining changelog and technical docs consistency requires a repeatable post-release workflow that updates user-centric functionality docs and developer tech references together. Archiving completed plans also ensures full traceability of project changes.

When do I need to update CLAUDE.md in my project workflow?

You need to update CLAUDE.md when your project structure or workflow changes significantly. Refreshing CLAUDE.md during post-feature documentation updates keeps project-level guidance aligned with recent engineering modifications.

How do I archive completed plans for feature traceability?

Archive completed plans by moving them under docs/plans/completed/ during post-feature documentation updates. This practice maintains documentation hygiene and provides clear historical traceability for delivered features.

Does post-release documentation work without manual changelog entry?

Yes, post-release documentation can automatically generate concise, user-centric changelog entries. The workflow handles changelog updates, functionality docs, and tech references to ensure consistency without manual changelog writing.