What metrics does this skill provide?

It provides a total score plus individual scores for accuracy, completeness, relevance, and actionability.

Why use this skill over a standard LLM prompt?

This skill enforces a standardized output format and specific scoring logic, ensuring consistent documentation quality across a project.

How is the accuracy score calculated?

The accuracy score is determined by analyzing the gap between the requirements found in docs/goal.md and the content of the target markdown file.

Can it identify specific technical issues?

Yes, the skill highlights critical issues, potential performance problems, and potential bugs within the content.

Structured Markdown Reviewer

Name: Structured Markdown Reviewer
Author: uuta

byuuta

•

Gestión de Contenido

Generates standardized, score-based feedback for markdown documentation to ensure accuracy and alignment with project goals.

The review-format skill provides a rigorous framework for evaluating markdown documents against specific requirements, typically defined in a project's goal.md file. It automates the quality assurance process by calculating granular scores for accuracy, completeness, and relevance while identifying critical issues, performance bottlenecks, and potential bugs. This skill is essential for maintainers and developers who need to ensure that their documentation remains technically accurate and actionable as the codebase evolves.

Características Principales

01Standardized output format for consistent peer reviews

02Automated gap analysis between goal documentation and target markdown

031 GitHub stars

04Multi-dimensional scoring including Accuracy, Completeness, and Relevance

05Identification of potential bugs within documentation context

06Detection of critical issues and potential performance bottlenecks

Casos de Uso

01Automating the review process for markdown-based project proposals

02Auditing technical documentation for alignment with functional requirements

03Ensuring consistency between architecture goals and implementation docs

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add uuta/dotfiles review-format

For use in Claude.ai and ChatGPT

Download Skill