docs-review

The 'docs-review' skill is designed to facilitate the review of documentation changes to ensure compliance with the Metabase writing style guide. It addresses the need for consistency and clarity in documentation by providing a structured process that reviewers can follow when assessing pull requests, files, or diffs that involve documentation markdown files. By adhering to this skill, reviewers can identify and flag issues that may hinder the readability and professionalism of the documentation, ultimately improving the user experience for those accessing the material.

This skill includes features such as the detection of review modes based on available tools, a comprehensive checklist of common issues related to tone, structure, formatting, and clarity, and a mandatory feedback format that ensures issues are clearly numbered and easy to reference. Reviewers are guided through a systematic process that helps them focus on significant issues that impact the quality of the documentation, allowing for a more efficient review workflow. The skill also emphasizes the importance of clear and constructive feedback, making it easier for contributors to understand and implement necessary changes.

Target users for the 'docs-review' skill include technical writers, documentation reviewers, and contributors involved in the Metabase project or any other projects that require adherence to specific writing standards. By using this skill, teams can streamline their documentation review process, maintain high-quality standards, and ensure that all documents meet the established style guide, thus enhancing overall communication and understanding among users.