lessons-learned-validator

Validate lessons-learned documentation against format, size, and naming standards.

1|1|Updated Jun 28, 2025
One-click install
npx skills add https://github.com/DarkMonkDev/WitchCityRope --skill lessons-learned-validator
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: lessons-learned-validator
Source: https://github.com/DarkMonkDev/WitchCityRope/tree/main/.claude/skills/lessons-learned-validator
Command: npx skills add https://github.com/DarkMonkDev/WitchCityRope --skill lessons-learned-validator

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires bash, grep, wc, find, sed, and includes scripts (resource) components.

What problem does it solve?

Inconsistent, oversized, or poorly formatted lessons learned documents hinder knowledge sharing, lead to miscommunication, and make it difficult to extract actionable insights. This Skill automates the enforcement of documentation standards.

Core Features & Use Cases

  • Format Validation: Ensures each lesson follows the mandatory "Problem → Solution → Example" structure.
  • Size Management: Automatically checks file size limits (2,000 lines) and guides multi-file splitting procedures to prevent context overload.
  • Quality Checks: Validates naming conventions, supported roles, and the use of prevention-focused language.
  • Use Case: Before committing updates to your react-developer-lessons-learned.md file, use this Skill to automatically verify it adheres to all formatting, size, and quality standards.

Quick Start

Validate the 'react-developer-lessons-learned.md' file to ensure it meets all quality standards.

Frequently Asked Questions about lessons-learned-validator

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

FAQPage Schema
How do I validate lessons-learned documentation for formatting and standards?

Lessons-learned validation enforces mandatory Problem → Solution → Example structure, checks file size limits (2,000 lines), verifies naming conventions, and ensures prevention-focused language across your documentation repository. Run the validator against your lessons file before committing updates.

What standards does lessons-learned validation check for?

The validator enforces consistent naming conventions, Problem/Solution/Example structure, prevention-focused language, cross-references, multi-file headers, and maximum 2,000-line file size limits to maintain knowledge quality and readability across your lessons repository.

Can I use lessons-learned validation to split oversized documentation files?

Yes, the validator automatically detects files approaching or exceeding 2,000 lines and guides multi-file splitting procedures, preventing context overload while maintaining consistent format and naming standards across split files.

How do I ensure my lessons-learned files follow naming conventions and quality standards?

The validator checks supported role naming, enforces documentation structure requirements, validates file organization protocols, and confirms prevention-focused language compliance—identifying gaps before changes are committed to your repository.

What happens if my lessons-learned documentation exceeds size limits?

The validator flags files at or near the 2,000-line threshold and provides guidance on multi-file management strategies, ensuring your documentation stays organized, searchable, and maintainable across the repository.

Does lessons-learned validation work with existing documentation repositories?

Yes, the validator applies to Phase 5 finalization, new lesson additions, and existing files regardless of size, enforcing consistent standards across your entire lessons-learned documentation repository using standard bash utilities.