updating-documentation

Update README, CHANGELOG, and API docs after code changes.

Updated Dec 31, 2025
One-click install
npx skills add https://github.com/tomgun/agentic-framework --skill updating-documentation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: updating-documentation
Source: https://github.com/tomgun/agentic-framework/tree/main/.agentic/lib/agents/claude/skills/updating-documentation
Command: npx skills add https://github.com/tomgun/agentic-framework --skill updating-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keep documentation in sync with code changes to prevent outdated READMEs, missing changelog entries, and incorrect API or configuration docs that confuse users and contributors.

Core Features & Use Cases

  • Change identification: Determine which documentation files need updates by examining recent commits and diffs.
  • Targeted updates: Edit README, CHANGELOG, API, configuration, and architecture docs to reflect new features, altered behavior, and updated examples.
  • Project integration: Use repository scripts to record outcomes (journal/status) and ensure version or release notes are consistent with code changes.
  • Use case: After merging a feature branch that adds authentication, update the README installation steps, API docs for new endpoints, and add a changelog entry describing the change.

Quick Start

Run the updating-documentation process to scan recent commits, update affected README and API docs, and add a changelog entry.

Frequently Asked Questions about updating-documentation

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

FAQPage Schema
How do I update README and API documentation after merging new code changes?

To update README and API documentation after merging code changes, you can scan recent git commits and diffs to identify altered files, then edit the affected docs to reflect new features and updated examples.

What is the best way to keep a changelog and documentation in sync with git commits?

Keeping a changelog and documentation in sync involves examining recent git commits to determine necessary updates, then modifying README, API, and configuration docs to accurately describe the altered behavior and new features.

How do I automatically identify which documentation files need updates after a feature implementation?

You can identify which documentation files need updates by examining recent repository commits and code diffs to detect altered behavior, then targeting README, API, and configuration docs that require corresponding changes.

Can I add changelog entries and update repo documentation without manual file checks?

Yes, you can add changelog entries and update repo documentation by scanning recent commits to find changed files, then automatically editing affected docs and integrating with project scripts to record status updates.

Does updating documentation require file read and write access to the repository?

Yes, updating documentation requires file read and write access to the repository to examine recent commits and modify README, CHANGELOG, API, and configuration docs after feature implementation or pull requests.

When do I need to update configuration and architecture docs in my repository?

You need to update configuration and architecture docs after feature implementation or pull requests when recent commits alter project behavior, ensuring your repository documentation stays accurate and prevents outdated examples.