review-format
Output in the specified format when a review of specific markdown is requested.
When & Why to Use This Skill
The review-format skill is a specialized utility designed to automate the evaluation of Markdown documents. It performs a structured analysis by comparing target content against defined goals or reference documentation, generating a comprehensive report that includes numerical scores for accuracy, completeness, and relevance. This tool is essential for maintaining high standards in technical documentation by identifying critical issues, potential bugs, and performance bottlenecks automatically.
Use Cases
- Technical Documentation QA: Automatically audit README files or API documentation to ensure they align perfectly with project requirements and goal specifications.
- Automated Content Grading: Provide objective, data-driven scores for technical articles or internal SOPs based on their completeness and actionability.
- CI/CD Integration for Docs: Incorporate into development workflows to flag potential bugs or formatting issues in markdown files before they are merged into the main branch.
- Gap Analysis: Identify specific discrepancies between intended documentation goals and the actual written output to streamline the editing process.
| name | review-format |
|---|---|
| description | Output in the specified format when a review of specific markdown is requested. |
- Score (up to 100)
- Accuracy score (up to 100 – this score is calculated by a gap between docs/goal.md and the target markdown. The smaller the gap is, the higher the score is)
- Completeness Score
- Relevance Score
- Actionability Score
- Short summary
- Critical issue
- Potentially performance issue
- potential bug