skill-doc-diff

Automate Qt Doc Team diff reviews with a structured template.

19|29|Updated May 6, 2013
One-click install
npx skills add https://github.com/qt/qtqa --skill skill-doc-diff
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: skill-doc-diff
Source: https://github.com/qt/qtqa/tree/main/documentation_review/skills/skill-doc-diff
Command: npx skills add https://github.com/qt/qtqa --skill skill-doc-diff

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides a standardized approach to reviewing Qt doc changes by applying a structured diff template, ensuring consistency and traceability.

Core Features & Use Cases

  • Structured review template for Qt Doc Team diffs.
  • Validation guidance including category, warning, source, and output fields.
  • Audit-ready notes section to capture exemptions and rationale for decisions.

Quick Start

Apply the template to a Qt doc diff to generate a complete, reviewable assessment.

Frequently Asked Questions about skill-doc-diff

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

FAQPage Schema
How do I perform a structured Qt documentation diff review?▼

To perform a structured Qt documentation diff review, apply a standardized template that enforces consistent categorization, validation fields, and formal justification for audit-ready traceability across documentation changes.

What is the best way to ensure consistency when reviewing Qt doc changes?▼

The best way to ensure consistency when reviewing Qt doc changes is using a fixed output schema with fields for category, keywords, dependencies, and toxicity checks, capturing exemptions and rationale for formal decisions.

How does a validation template help with documentation QA checklists?▼

A validation template helps with documentation QA checklists by automating the creation of reviewable assessments, enforcing fixed output schemas for category and warning fields, and providing audit-ready notes to capture rationale.

Can I use this structured review template for non-Qt documentation diffs?▼

This structured review template is specifically applied to Qt Doc Team diff workflows where diff-like changes require consistent categorization and formal justification, making it less suitable for non-Qt documentation environments.

What fields are required in a Qt doc diff review output?▼

Required fields in a Qt doc diff review output include name, tagline, description, request, complexity, category, keywords, dependencies, components, and toxicity check, alongside safety considerations and audit notes.