pr-faq-validator

README

pr-faq-validator

Get a 0-100 score for your PR-FAQ in seconds. Checks structure, 5 Ws coverage, quote quality, and marketing fluff.

Quick Start (Web)

1. Open bordenet.github.io/pr-faq-validator
2. Paste your PR-FAQ markdown
3. See your score update live as you type

No install. No API keys. Works in any browser.

Quick Start (CLI)

git clone https://github.com/bordenet/pr-faq-validator.git
cd pr-faq-validator
go build -o pr-faq-validator .
./pr-faq-validator -file path/to/your/prfaq.md

Requires Go 1.21+. Use -no-tui for non-interactive output. Optional: set OPENAI_API_KEY for AI feedback.

What It Scores

Category	Points	What It Checks
Structure & Hook	30	Headline, dateline, newsworthy opening
Content Quality	35	5 Ws coverage (WHO, WHAT, WHEN, WHERE, WHY)
Professional Quality	20	Tone, readability, marketing fluff detection
Customer Evidence	15	Quote quality with quantitative metrics

Scoring Modes (Web Only)

Toggle between two scoring approaches:

Quick Score (Default)

Instant JavaScript-based scoring using pattern matching. Fast and free, but limited to what regex can detect.

LLM Score

Copy a comprehensive scoring prompt to Claude.ai for context-aware evaluation. The LLM:

• Understands nuance and context
• Catches semantic issues (vague claims that sound specific)
• Provides detailed justification for each score
• Suggests specific improvements

Use LLM scoring when you need rigorous feedback before finalizing your PR-FAQ.

AI Power-ups (Web Only)

The web version includes copy-to-clipboard prompts for Claude.ai:

• Critique — Get detailed feedback with a revised draft
• Rewrite — Get a complete rewritten PR-FAQ

CLI Usage

# Interactive TUI mode
./pr-faq-validator -file testdata/example_prfaq_1.md

# Non-interactive (for scripts/CI)
./pr-faq-validator -file your-prfaq.md -no-tui

# Generate markdown report
./pr-faq-validator -file your-prfaq.md -report report.md

# With AI feedback (requires API key)
export OPENAI_API_KEY=sk-...
./pr-faq-validator -file your-prfaq.md

Related Tools

• pr-faq-assistant — Generate PR-FAQs from scratch using adversarial AI
• The PR-FAQ Guide — Learn how to write effective PR-FAQs

Code Coverage

License

MIT

Documentation

Overview

Package main provides the CLI entry point for the PR-FAQ validator tool.