Content Quality Analysis 2.0

A comprehensive CQA 2.1 (Content Quality Assessment) skill for auditing Red Hat technical documentation with automated batch processing and full repository support.

⚠️ Prerequisites

You need to have:

1. Claude Code installed and configured
2. Your product-specific OPL PDF ready
   • File name format: OPL-<ProductName>.pdf
   • Examples: OPL-OpenShift.pdf, OPL-RHEL.pdf, OPL-Ansible.pdf

Don't have your product OPL? The installation will work, but product name validation will be incomplete. Get your OPL PDF before running audits.

---

📦 What's Included

cqa-2.0/                             # Clone this repository
├── .claude/
│   └── skills/
│       ├── doc-quality-audit.md    # Main skill workflow
│       └── install.sh               # Installation script
├── standards/                       # Gets installed to ~/.claude/cqa-standards/
│   ├── CQA-Step-by-Step-Assessment-Guide.md
│   ├── modular-docs.md
│   ├── peer-review-style.md
│   ├── templates/                   # Official AsciiDoc templates
│   ├── OPL.pdf                      # General OPL (278 KB)
│   └── REQUIRED_FILES_README.md     # Setup documentation
└── README.md                        # This file

After Installation:

~/.claude/skills/                    # Global skills location
└── doc-quality-audit.md            # CQA skill available globally

~/.claude/cqa-standards/             # Global standards location
├── CQA-Step-by-Step-Assessment-Guide.md
├── modular-docs.md
├── peer-review-style.md
├── templates/
├── OPL.pdf
├── OPL-<YourProduct>.pdf           # You add this
└── REQUIRED_FILES_README.md

your-doc-project/                    # Your documentation project
└── (your doc files only)           # ✅ COMPLETELY CLEAN - no CQA files!

---

🚀 Quick Start

Installation

Note: Install CQA 2.0 once globally, then use it in any documentation project. Zero files added to your doc repos!

1. Clone this repository (one-time setup):

   cd ~
   git clone https://github.com/shivanisathe25/cqa-2.0.git

2. Run the global installer:

   cd ~/cqa-2.0/.claude/skills
   ./install.sh

   This installs globally:

   • ✅ Skill → ~/.claude/skills/doc-quality-audit.md
   • ✅ Standards → ~/.claude/cqa-standards/
   • ✨ Your doc projects stay completely clean!

3. ⚠️ ADD your product-specific OPL PDF:

   cp /path/to/your/OPL-ProductName.pdf ~/.claude/cqa-standards/

4. Verify setup:

   ls ~/.claude/skills/doc-quality-audit.md
   ls ~/.claude/cqa-standards/*.pdf

   You should see the skill file and both OPL.pdf + OPL-<YourProduct>.pdf

Usage

Open your documentation project in Claude Code and use the following prompt:

cd /path/to/your-doc-project
claude

# Then in Claude:
Audit all files in .<folder/assembly-name>

Alternative phrasings:

• Assess all documentation in /path/to/docs
• Run CQA audit on <folder-name>/
• Audit assembly-<assembly-name>.adoc and all its modules

---

📊 What It Audits

CQA 2.1 Requirements (17 checks)

Category	Requirements	Details
AsciiDoc	1	Assembly structure, formatting
Modularization	5	Templates, separation, user stories
Titles & Descriptions	3	Quality, format, character counts (50-300)
Procedures	1	Prerequisites formatting
Editorial	2	Grammar, content type correctness
URLs & Links	3	Broken links, redirects, interlinking
Legal & Branding	2	Product names, disclaimers

Output

Generates comprehensive report: assessments/assessment_<repo-name>_<date>.md

Includes:

• Executive summary with compliance metrics
• Assembly-based organization
• File-by-file assessment with ✅/❌ status
• Character count analysis with attribute resolution
• Critical blockers requiring fixes
• Prioritized action list with effort estimates
• Migration readiness checklist

---

🔍 Verification

Before running audits, verify your setup:

# Check that skill is installed globally
ls ~/.claude/skills/doc-quality-audit.md

# Check that standards are installed globally
ls ~/.claude/cqa-standards/

# Check for required PDFs
ls ~/.claude/cqa-standards/*.pdf

Expected Output:

✅ Correct setup:

$ ls ~/.claude/skills/doc-quality-audit.md
/home/user/.claude/skills/doc-quality-audit.md

$ ls ~/.claude/cqa-standards/*.pdf
/home/user/.claude/cqa-standards/OPL.pdf
/home/user/.claude/cqa-standards/OPL-OpenShift.pdf

⚠️ Missing product OPL:

$ ls ~/.claude/cqa-standards/*.pdf
/home/user/.claude/cqa-standards/OPL.pdf

# Action needed:
cp /path/to/your/OPL-ProductName.pdf ~/.claude/cqa-standards/

❌ Not installed:

$ ls ~/.claude/cqa-standards/
ls: cannot access '~/.claude/cqa-standards/': No such file or directory

# Action needed: Run installation
cd ~/cqa-2.0/.claude/skills
./install.sh

🎯 Example Workflow

Scenario: Pre-Migration Assessment

# 1. Clone CQA 2.0 (one-time setup)
cd ~
git clone https://github.com/shivanisathe25/cqa-2.0.git

# 2. Install globally (one-time setup)
cd ~/cqa-2.0/.claude/skills
./install.sh

# Installation output:
# ✅ Skill installed to ~/.claude/skills/doc-quality-audit.md
# ✅ Standards installed to ~/.claude/cqa-standards
# ✨ Your documentation projects stay completely clean!

# 3. Add product-specific OPL to global location
cp ~/downloads/OPL-OpenShift.pdf ~/.claude/cqa-standards/

# 4. Verify setup
ls ~/.claude/skills/doc-quality-audit.md
ls ~/.claude/cqa-standards/*.pdf
# Should show: skill file, OPL.pdf and OPL-OpenShift.pdf

# 5. Open ANY doc project in Claude Code (OpenShift example)
cd ~/openshift-docs
claude

# 6. Request audit (natural language)
You: Audit all files in .

# 7. Claude automatically:
#    ✓ Finds skill from ~/.claude/skills/
#    ✓ Verifies prerequisites from ~/.claude/cqa-standards/
#    ✓ Discovers 106 .adoc files
#    ✓ Groups by assemblies
#    ✓ Processes all files
#    ✓ Generates comprehensive report

# 8. Review report
cat assessments/assessment_openshift-docs_2026-02-27.md

# Output shows:
# - Overall compliance: 98% (104/106 files passing)
# - Critical blockers: 2 files
# - Estimated fix effort: 2 hours
# - ✅ READY FOR MIGRATION (after fixes)

# 9. Use in another project (no installation needed!)
cd ~/rhel-docs
claude
You: Audit all files in .
# Works immediately! Same global skill and standards.

# 10. Check your doc projects - still clean!
ls ~/openshift-docs/.claude/  # Does NOT exist
ls ~/rhel-docs/.claude/       # Does NOT exist
# ✅ Zero CQA files in your doc repositories!

---

Using in Multiple Projects

# No installation needed! Since everything is global:
cd ~/openshift-docs
claude
# Skill works immediately

cd ~/rhel-docs
claude
# Skill works here too

cd ~/ansible-docs
claude
# And here!

💡 Common Issues

"Skill not found"

# Verify skill is installed globally
ls ~/.claude/skills/doc-quality-audit.md

# If missing, install globally
cd ~/cqa-2.0/.claude/skills
./install.sh

"Standards not found" or "Prerequisites check failed"

# Check global standards location
ls ~/.claude/cqa-standards/

# If empty or missing, install globally
cd ~/cqa-2.0/.claude/skills
./install.sh

"Product name validation incomplete"

# Check for product-specific OPL
ls ~/.claude/cqa-standards/OPL-*.pdf

# If only OPL.pdf exists, add your product OPL
cp /path/to/OPL-YourProduct.pdf ~/.claude/cqa-standards/