docs-review

Evaluate RFC, ADR, and README documents for structural quality and adherence to best practices.

18|1|Updated Jan 3, 2026
One-click install
npx skills add https://github.com/williamzujkowski/nexus-agents --skill docs-review-williamzujkowski
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-review
Source: https://github.com/williamzujkowski/nexus-agents/tree/main/skills/docs-review
Command: npx skills add https://github.com/williamzujkowski/nexus-agents --skill docs-review-williamzujkowski

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the process of assessing the clarity, structure, and technical accuracy of documentation, saving reviewers time and providing objective, detailed feedback.

Core Features & Use Cases

  • Structural Analysis: Extracts heading hierarchy, paragraph length, citations, and internal references to identify mechanical issues.
  • Rubric-Based Scoring: Integrates with existing skills to evaluate argument strength, evidence, content quality, structure, and audience fit.
  • Use Case: When reviewing an RFC or technical blog post, this Skill provides a quantified quality score and surfaces top issues for targeted improvement.

Quick Start

Provide the path to a documentation file, and the skill will analyze its structure and generate a quality assessment report.

Frequently Asked Questions about docs-review

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

FAQPage Schema
How do I review technical documentation for quality and consistency?

You can review technical documentation by evaluating structural integrity, clarity, and adherence to best practices. This skill analyzes heading hierarchy, paragraph length, and internal references to identify mechanical issues and generate a quality assessment report.

What is rubric-based scoring for technical writing assessment?

Rubric-based scoring for technical writing evaluates argument strength, evidence, content quality, structure, and audience fit. It provides a quantified quality score across multiple dimensions, helping technical reviewers identify top issues for targeted improvement.

Can I evaluate an RFC or ADR for structural integrity automatically?

Yes, you can evaluate RFCs and ADRs for structural integrity automatically. This skill extracts heading hierarchy, paragraph length, citations, and internal references to identify mechanical issues and generate a quantified quality score.

How do I assess the clarity and audience fit of a README file?

Assessing clarity and audience fit of a README involves evaluating content quality and structure against best practices. This skill provides a quantified quality score and surfaces top issues for targeted improvement across multiple dimensions.

What's the best way to identify top issues in a technical blog post?

The best way to identify top issues in a technical blog post is through rubric-based scoring that evaluates argument strength, evidence, and structure. This skill surfaces top issues and provides a quantified quality score for targeted improvement.

Does this documentation review tool require any dependencies or setup?

No dependencies or setup are required. You simply provide the path to a documentation file, and the skill analyzes its structure and generates a quality assessment report evaluating clarity, structure, and technical accuracy.