review-format

Format markdown reviews into structured reports with numeric scores and issue notes.

1|2|Updated Jul 5, 2024
One-click install
npx skills add https://github.com/uuta/dotfiles --skill review-format
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: review-format
Source: https://github.com/uuta/dotfiles/tree/main/skills/review-format
Command: npx skills add https://github.com/uuta/dotfiles --skill review-format

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Markdown reviews are often inconsistent and hard to compare across documents. This Skill standardizes evaluation by producing a fixed set of scores and issue notes, enabling quick, objective comparisons.

Core Features & Use Cases

  • Structured scoring: returns Score, Accuracy score, Completeness Score, Relevance Score, and Actionability Score.
  • Issue notes and summary: provides a Short summary, Critical issue, Potential performance issue, and Potential bug to guide improvements.
  • Use cases: ideal for reviewing documentation, READMEs, proposals, or policy pages to ensure clarity, quality, and compliance for teams and AI assistants.
  • Automation friendly: outputs a consistent schema that can be consumed by downstream tools or AI copilots to drive improvements.

Quick Start

Review the attached Markdown document and return a structured evaluation including the scores, short summary, and issue notes.

Frequently Asked Questions about review-format

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I standardize markdown reviews with a consistent scoring format?▼

To standardize markdown reviews, use this skill to format documents into a fixed report with numeric scores, a short summary, and issue notes. It ensures objective comparisons across documentation, code reviews, and compliance verifications.

What is structured output for document evaluation and when do I need it?▼

Structured output for document evaluation is a fixed schema containing scores, summaries, and issue notes. You need it when comparing documentation, proposals, or policy pages across teams to ensure consistent quality, clarity, and compliance.

How do I generate numeric scores and issue notes for a README file?▼

To generate numeric scores and issue notes for a README, attach the markdown document to this skill. It evaluates the content and returns accuracy, completeness, relevance, and actionability scores alongside critical issues and bugs.

Can I use a structured markdown review report for compliance verification?▼

Yes, you can use a structured markdown review report for compliance verification. The skill applies a consistent rubric to output fixed fields including scores, issue notes, and summaries, ensuring documentation meets required compliance standards.

Does this structured review skill output a schema for downstream AI copilots?▼

Yes, this structured review skill outputs a consistent schema designed for downstream tools and AI copilots. The automation-friendly format includes fixed scores and issue notes to drive automated documentation improvements.

What is the best way to compare documentation quality across multiple markdown files?▼

The best way to compare documentation quality across multiple markdown files is using a fixed evaluation rubric. This skill standardizes reviews by producing consistent scores and issue notes, enabling quick and objective comparisons.