skill-doc-audit

Define a structured template for documenting documentation audit findings.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This template provides a standardized, machine-parseable format for documenting documentation audits and impact analyses, reducing ambiguity and enabling automated reporting.

Core Features & Use Cases

  • Structured headers: Header, Summary Table, Special Section, Findings, Notes, and Verdict.
  • Supports two agent profiles (Structure Audit and Impact Analysis) with field-validated sections and a Cross-Product Impact area for broader checks.
  • Enables consistent reporting, automated parsing, and traceable decisions across Qt module documentation.

Quick Start

Create a new Skill unit using this template to document a Qt module's documentation audit.

Frequently Asked Questions about skill-doc-audit

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

FAQPage Schema
What is a machine-parseable format for documentation audit findings?

A machine-parseable documentation audit format uses structured headers, summary tables, and validated findings sections to standardize reporting. This enables automated agents to extract statuses, impact validations, and traceable decisions without manual parsing efforts.

How do I automate documentation structure audits and impact analysis?

You can automate documentation audits by deploying doc-structure-auditor and doc-impact-analyzer agent profiles against a structured template. The template defines specific headers, field validations, and a cross-product impact section to guide automated extraction.

Does this documentation audit template support cross-product impact analysis?

Yes, the documentation audit template includes a dedicated cross-product impact section. This allows the doc-impact-analyzer agent profile to perform broader checks and document cross-module effects directly within the standardized findings format.

What sections are required when documenting documentation audit findings?

Documenting documentation audit findings requires structured headers, a summary table, special sections, findings with validations, notes, and a verdict. These machine-parsable fields ensure consistent reporting and enable automated extraction of audit results.

Can I use this template for manual reporting instead of automated agent parsing?

Yes, you can use this structured template for manual documentation audits. While it provides machine-parsable fields and parsing guidance for automated agents, the standardized headers, summary tables, and verdict sections also ensure traceable decisions and consistent manual reporting.

Why do I need a standardized template for documentation audits?

A standardized documentation audit template reduces ambiguity and enables automated reporting. By defining machine-parsable fields for structure audits and impact analyses, it ensures consistent reporting and traceable decisions across different Qt module documentation reviews.