Update Api Docs

What it does

This skill automatically updates API documentation based on changes to code. It analyzes existing documentation, identifies discrepancies with current code, and generates updated documentation in a standardized format. This ensures that API documentation remains accurate and reflects the latest codebase modifications.

When to use it

• After code refactoring: Automatically update documentation when APIs are modified or reorganized.
• During continuous integration/continuous deployment (CI/CD): Integrate into your CI/CD pipeline to keep documentation in sync with deployments.
• For large projects with frequent API changes: Reduce the manual effort required to maintain accurate and up-to-date API documentation.
• To standardize documentation format: Enforce a consistent style across all API documentation.

Key capabilities

• Automated documentation updates
• Discrepancy detection between code and documentation
• Standardized documentation output
• Integration with CI/CD pipelines

Example prompts

• "Update the API documentation for the /users endpoint."
• "Generate updated documentation based on the latest changes to src/api.js."
• "Refresh all API documentation and ensure it follows the OpenAPI 3.0 specification."

Tips & gotchas

• The skill requires access to both the codebase and existing API documentation. Ensure proper permissions are configured.
• The quality of the updated documentation depends on the clarity and structure of the original code comments and documentation.