cqa-tools

Run a CQA 2.1 content quality assessment against a Red Hat modular documentation repository

Use when starting or continuing a full CQA 2.1 content quality assessment. Guides through all three tabs (Pre-migration, Quality, Onboarding) parameter by parameter.

Use when assessing CQA parameters P13-P14, Q1-Q5, Q18, Q20 (editorial quality). Checks grammar, content types, readability, scannability, fluff, style guide compliance, and tone.

Use when assessing CQA parameters P18-P19, Q17, Q23, O1-O5 (legal, branding, and compliance). Checks product names, Tech Preview disclaimers, conscious language, non-RH link disclaimers, and copyright.

Use when assessing CQA parameters P15-P17, Q24-Q25 (links and URLs). Checks for broken xrefs, missing includes, missing images, redirect integrity, and content interlinking.

Use when assessing CQA parameters P2-P7 (modularization). Checks assembly structure, module prefixes, required elements, templates, and nesting depth.

Use when assessing CQA parameters O6-O10 (onboarding to docs.redhat.com). Checks support disclaimers, SME verification, source format, Pantheon publishing, and official site publication.

Use when assessing CQA parameters P12, Q12-Q16 (procedure quality). Checks prerequisites, step counts, command examples, optional/conditional step formatting, verification sections, and Additional resources.

Use when all CQA parameters have been assessed and you need to generate the final CQA 2.1 assessment report with scores, evidence, and summary tables.

Use when assessing CQA parameters Q19, Q21-Q22 (tables and images). Checks for excessive screenshots, table captions, and image alt text.

Use when assessing CQA parameters P8-P11 (titles and short descriptions). Checks abstract quality, character limits, and title conventions.

Use when assessing CQA parameters Q6-Q11 (user focus). Checks persona targeting, pain point coverage, acronym expansion, Additional resources quality, admonition density, and assembly introduction audience targeting.

Use when assessing CQA parameter P1 (Vale DITA check). Runs Vale with AsciiDocDITA rules (direct for repo scope, dita-tools:dita-validate-asciidoc for assembly/topic scope) and fixes violations to achieve 0 errors and 0 warnings.