do-documentation-update

Update CHANGELOG, AGENTS.md, README.md, and skill files with validation.

4|1|Updated Dec 30, 2025
One-click install
npx skills add https://github.com/lushly-dev/afd --skill do-documentation-update
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: do-documentation-update
Source: https://github.com/lushly-dev/afd/tree/main/.claude/skills/do-documentation-update
Command: npx skills add https://github.com/lushly-dev/afd --skill do-documentation-update

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures that your project's documentation (CHANGELOG, AGENTS.md, README.md, and skill files) accurately reflects the current state of your code, preventing outdated information and maintaining consistency.

Core Features & Use Cases

  • Automated Documentation Checks: Verifies changelog entries, agent descriptions, and README updates against code changes.
  • Linting and Validation: Checks skill file structure, frontmatter, and internal/external links for errors.
  • Use Case: After implementing a new feature and fixing a bug, run this Skill to automatically update the CHANGELOG with the new entries, ensure AGENTS.md lists the new command, and verify all internal links in the documentation are still valid.

Quick Start

Run the documentation update pass to ensure all project documentation is synchronized with recent code changes.

Frequently Asked Questions about do-documentation-update

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

FAQPage Schema
How do I keep my README and CHANGELOG in sync with code changes?

To sync your README and CHANGELOG with code changes, run an automated documentation update pass that validates changelog formatting, semver alignment, and version-tag consistency against your current codebase.

What is the best way to automate documentation checks after a new release?

Automating documentation checks after a release involves validating changelog entries, verifying agent descriptions in AGENTS.md, and running link integrity checks across all project docs to ensure they reflect recent code changes.

How does changelog linting and semver validation work for project documentation?

Changelog linting and semver validation work by checking skill file structure, frontmatter, and internal links, ensuring that your version tags and changelog entries accurately match the current state of your codebase.

Do I need to manually update AGENTS.md when adding a new command?

You do not need to manually update AGENTS.md when adding a new command, as running a comprehensive documentation update pass will automatically verify that AGENTS.md lists the new command and aligns with your code changes.

Can I check internal and external links in my skill files automatically?

You can check internal and external links in skill files by running documentation linting and validation checks, which verify frontmatter, file structure, and link integrity alongside manual verification steps.