Doc Prd Audit

What it does

The doc-prd-audit skill automates the process of reviewing product documentation for accuracy and completeness. It identifies missing sections, outdated information, and inconsistencies against a defined set of criteria. This ensures that documentation remains reliable and supports effective user onboarding and troubleshooting.

When to use it

• Pre-release Documentation Review: Before launching a new product or feature, ensure all associated documentation is accurate and complete.
• Post-Update Documentation Validation: After updating a product, automatically verify the corresponding documentation reflects those changes.
• Compliance Audits: Maintain consistent documentation quality for regulatory compliance purposes.
• Knowledge Base Maintenance: Regularly audit your knowledge base to identify and correct outdated or inaccurate articles.

Key capabilities

• Automated review against defined criteria
• Identification of missing sections
• Detection of outdated information
• Consistency checks across documents

Example prompts

• "Audit the documentation for product X, focusing on section Y."
• "Review all onboarding guides and flag any references to deprecated features."
• "Check the API documentation against the latest release notes."

Tips & gotchas

The effectiveness of this skill depends heavily on providing clear and comprehensive audit criteria. Ensure these are well-defined before initiating a review for optimal results.