spec-proofreader

Review specification documents for repetition, contradictions, undefined terms, and formatting inconsistencies.

Updated Nov 27, 2025
One-click install
npx skills add https://github.com/wtsi-hgi/llm-knowledge-base --skill spec-proofreader
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: spec-proofreader
Source: https://github.com/wtsi-hgi/llm-knowledge-base/tree/main/.github/skills/spec-proofreader
Command: npx skills add https://github.com/wtsi-hgi/llm-knowledge-base --skill spec-proofreader

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill addresses common text quality issues in specification documents that arise from LLM generation, ensuring clarity, accuracy, and adherence to formatting standards.

Core Features & Use Cases

  • Error Detection: Identifies repetition, contradictions, undefined terms, and placeholder text.
  • Structural Validation: Verifies section and story numbering, cross-references, and adherence to user story formats.
  • Formatting & Compliance: Enforces ASCII compliance, line wrapping, consistent whitespace, and proper Markdown structure.
  • Use Case: A spec writer can use this skill to automatically catch and fix formatting errors, numbering inconsistencies, and textual ambiguities in a draft specification before it's finalized, ensuring a high-quality, professional document.

Quick Start

Use the spec-proofreader skill to review the document at /path/to/specification.md.

Frequently Asked Questions about spec-proofreader

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

FAQPage Schema
How do I proofread a specification document for formatting inconsistencies and undefined terms?

To proofread a specification document, you can review it for repetition, contradictions, undefined terms, and formatting inconsistencies. This skill validates section numbering, cross-references, and ASCII compliance, fixing identified errors directly within the Markdown file.

What is the best way to fix LLM generation errors in a draft specification?

Fixing LLM generation errors in a draft specification involves identifying textual ambiguities, placeholder text, and structural issues. You can use this skill to automatically catch and directly correct these text quality problems, ensuring clarity and professional document standards.

How do I validate user story numbering and cross-references in a spec?

Validating user story numbering and cross-references in a spec requires structural verification checks. This skill automatically verifies section and story numbering, ensuring adherence to user story formats and fixing inconsistencies directly within the document.

Can I check Markdown specifications for ASCII compliance and line wrapping?

Yes, you can check Markdown specifications for ASCII compliance and line wrapping. This skill enforces consistent whitespace, proper Markdown structure, and ASCII compliance, automatically fixing these formatting errors before the document is finalized.

Does this spec proofreader require any dependencies to run?

No, this spec proofreader does not require any dependencies to run. It operates directly on the specified document path to review text quality issues, structural formatting, and Markdown compliance without needing external components.