Ogt Docs Audit Task

What it does

This skill, ogt-docs-audit-task, allows AI agents to audit documentation for completeness and accuracy. It can identify missing sections or outdated information based on predefined criteria. The tool aims to improve the quality of technical documentation by automating a portion of the review process.

When to use it

• Content Updates: After significant changes to a product or service, use this skill to ensure all related documentation is updated accordingly.
• New Feature Rollout: Before releasing a new feature, verify that its documentation covers all aspects and potential user scenarios.
• Regular Maintenance: Schedule periodic audits of existing documentation to maintain accuracy and relevance over time.
• Knowledge Base Review: Assess the completeness and correctness of information within an internal or external knowledge base.

Key capabilities

• Documentation auditing
• Completeness checks
• Accuracy verification
• Identification of missing sections

Example prompts

• "Audit the documentation for our new API endpoint, focusing on error handling."
• “Check the user guide for version 3.2 to ensure it aligns with the latest release notes.”
• "Perform a completeness audit of the 'Getting Started' section for our product."

Tips & gotchas

The effectiveness of this skill depends heavily on the quality and specificity of any predefined criteria or templates provided. Ensure these are well-defined to yield accurate results.