Docs Check

What it does

The lukasstrickler-docs-check skill provides a way to verify documentation against specific criteria. It can check if all required sections are present, ensuring completeness and consistency across documents. This helps maintain high quality and accuracy in technical writing and knowledge bases.

When to use it

• Technical Writing Review: Use this skill when reviewing newly written or updated documentation to ensure it meets established standards.
• Knowledge Base Maintenance: Regularly check your internal knowledge base for completeness and adherence to formatting guidelines.
• Onboarding Documentation: Validate onboarding materials to guarantee new team members receive all necessary information.
• API Reference Generation: Verify that API reference documents include all required parameters, descriptions, and examples.

Key capabilities

• Documentation verification
• Section presence checks
• Consistency enforcement

Example prompts

• "Check the documentation for our 'User Authentication' feature."
• "Verify that the 'Installation Guide' includes a troubleshooting section."
• "Ensure all API endpoints in the reference document have descriptions."

Tips & gotchas

The skill requires clear definitions of expected sections and criteria to be effective. Providing detailed instructions or templates will improve accuracy and results.