Update Docs

What it does

The update-docs skill automates the process of updating documentation within a project, ensuring that all relevant files remain consistent and up-to-date with changes in code or functionality. It can parse existing documentation, identify discrepancies, and apply updates based on predefined rules or user input.

When to use it

• When maintaining large-scale projects where documentation often lags behind implementation.
• After making significant code changes and needing to ensure documentation reflects those updates.
• During continuous integration workflows to enforce documentation quality as part of the build process.
• When onboarding new team members who need accurate, current documentation for reference.

Key capabilities

• Automatic detection of outdated or missing documentation entries.
• Integration with version control systems for tracking changes.
• Support for multiple documentation formats (e.g., Markdown, reStructuredText).
• Customizable update rules based on project-specific needs.

Example prompts

• "Update the API reference section in the docs to reflect the latest endpoint changes."
• "Check and sync all README files with their corresponding code modules."
• "Generate a changelog entry for the new feature added in this commit."

Tips & gotchas

• Ensure that your documentation follows consistent formatting rules to avoid parsing errors.
• Review automated updates before committing them, as they may not capture nuanced changes accurately.