docs-review

Review documentation changes for style, accuracy, and completeness.

5.4k|739|Updated Jan 24, 2020
One-click install
npx skills add https://github.com/grafana/tempo --skill docs-review-grafana
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-review
Source: https://github.com/grafana/tempo/tree/main/.claude/skills/docs-review
Command: npx skills add https://github.com/grafana/tempo --skill docs-review-grafana

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Review documentation changes for style, accuracy, and completeness. Use when docs have been written or updated and need a quality check before submission.

Core Features & Use Cases

  • Triage for style vs. technical: Quickly identify whether changes are editorial or require technical verification.
  • Quality checks: Check frontmatter, verify internal links, and align with style guides and the references verification steps.
  • Automated checks: If Vale or a linter is available, run it against changed docs and surface style issues.

Quick Start

Invoke with /docs-review.

Frequently Asked Questions about docs-review

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

FAQPage Schema
How do I review documentation changes for style and technical accuracy before submission?

Review documentation changes by running automated checks against project style guides and verifying technical claims against the codebase. This process enforces frontmatter consistency, checks internal links, and triages editorial style versus technical accuracy.

What is the best way to check internal links and frontmatter in documentation updates?

Checking internal links and frontmatter involves enforcing frontmatter presence and consistency while validating link targets. A dedicated review process uses reference verification steps to ensure documentation updates meet project standards.

How do I verify technical claims in documentation against the codebase?

Verifying technical claims against the codebase requires applying a verification checklist during the documentation review. This triages technical accuracy by checking documentation updates against project references and actual codebase behavior.

Does the documentation review process work with Vale and linters for style checks?

Yes, documentation review works with Vale and available linters to surface style issues. If Vale or a linter is available, it runs against changed docs to automate style guide enforcement and identify editorial issues.

When do I need to run a documentation verification checklist?

Run a documentation verification checklist when docs have been written or updated and need a quality check before submission. It is required for PR submissions in Tempo-related docs to ensure style, accuracy, and completeness.

What is the difference between style triage and technical accuracy checks in documentation review?

Style triage identifies editorial issues aligned with style guides, while technical accuracy checks verify claims against the codebase. Documentation review distinguishes whether changes require editorial correction or deeper technical verification.