validate-report-file

Validate that worker-generated reports have all required sections and proper formatting. Use in quality gates, for report completeness checking, or when debugging missing report sections.

164 stars

Best use case

validate-report-file is best used when you need a repeatable AI agent workflow instead of a one-off prompt.

Validate that worker-generated reports have all required sections and proper formatting. Use in quality gates, for report completeness checking, or when debugging missing report sections.

Teams using validate-report-file should expect a more consistent output, faster repeated execution, less prompt rewriting.

When to use this skill

  • You want a reusable workflow that can be run more than once with consistent structure.

When not to use this skill

  • You only need a quick one-off answer and do not need a reusable workflow.
  • You cannot install or maintain the underlying files, dependencies, or repository context.

Installation

Claude Code / Cursor / Codex

$curl -o ~/.claude/skills/validate-report-file/SKILL.md --create-dirs "https://raw.githubusercontent.com/maslennikov-ig/claude-code-orchestrator-kit/main/.claude/skills/validate-report-file/SKILL.md"

Manual Installation

  1. Download SKILL.md from GitHub
  2. Place it in .claude/skills/validate-report-file/SKILL.md inside your project
  3. Restart your AI agent — it will auto-discover the skill

How validate-report-file Compares

Feature / Agentvalidate-report-fileStandard Approach
Platform SupportNot specifiedLimited / Varies
Context Awareness High Baseline
Installation ComplexityUnknownN/A

Frequently Asked Questions

What does this skill do?

Validate that worker-generated reports have all required sections and proper formatting. Use in quality gates, for report completeness checking, or when debugging missing report sections.

Where can I find the source code?

You can find the source code on GitHub using the link provided at the top of the page.

Related Guides

SKILL.md Source

# Validate Report File

Validate agent-generated report files for completeness and proper structure.

## When to Use

- Quality gate validation after worker completion
- Debugging missing report sections
- Ensuring report consistency
- Pre-submission validation

## Instructions

### Step 1: Read Report File

Use Read tool to load report file.

**Expected Input**:
- `file_path`: Path to report file (e.g., `bug-hunting-report.md`)

**Tools Used**: Read

### Step 2: Check Required Sections

Verify all required sections are present.

**Required Sections**:
1. **Header** with metadata:
   - Title (# Report Type Report: Version)
   - Generated timestamp
   - Status indicator (✅/⚠️/❌)
   - Version identifier

2. **Executive Summary**:
   - ## Executive Summary heading
   - Key metrics and findings

3. **Detailed Findings**:
   - Varies by report type
   - Must have at least one detail section

4. **Validation Results**:
   - ## Validation Results heading
   - Build/type-check status
   - Overall validation status

5. **Next Steps**:
   - ## Next Steps heading
   - Action items or recommendations

### Step 3: Validate Format

Check formatting and structure.

**Format Rules**:
- Title must be H1 (single #)
- Section headers must be H2 (##)
- Status must include emoji (✅/⚠️/❌)
- Code blocks must use proper markdown
- Lists must be properly formatted

### Step 4: Check Status Consistency

Verify status indicators are consistent.

**Consistency Checks**:
- Header status matches validation status
- If status is "failed", validation should show failures
- If status is "success", validation should show passes

### Step 5: Return Validation Result

Return detailed validation result.

**Expected Output**:
```json
{
  "valid": true,
  "file": "bug-hunting-report.md",
  "sections": {
    "header": true,
    "executiveSummary": true,
    "detailedFindings": true,
    "validationResults": true,
    "nextSteps": true
  },
  "warnings": [],
  "errors": []
}
```

## Error Handling

- **File Not Found**: Return error with file path
- **Missing Sections**: List all missing required sections
- **Invalid Format**: Describe format issues
- **Inconsistent Status**: Warn about status mismatches

## Examples

### Example 1: Valid Report

**Input**:
```
file_path: bug-hunting-report.md
```

**File Content**:
```markdown
# Bug Hunting Report: 2025-10-17

**Generated**: 2025-10-17 14:30:00 UTC
**Status**: ✅ success

---

## Executive Summary

Found 23 bugs across 147 files.

## Detailed Findings

### Critical (3)
- Bug 1
- Bug 2
- Bug 3

## Validation Results

- Type-check: ✅ PASSED
- Build: ✅ PASSED

**Overall**: ✅ PASSED

## Next Steps

1. Review critical bugs
2. Schedule fixes
```

**Output**:
```json
{
  "valid": true,
  "file": "bug-hunting-report.md",
  "sections": {
    "header": true,
    "executiveSummary": true,
    "detailedFindings": true,
    "validationResults": true,
    "nextSteps": true
  },
  "warnings": [],
  "errors": []
}
```

### Example 2: Missing Sections

**Input**:
```
file_path: incomplete-report.md
```

**File Content**:
```markdown
# Bug Report

Some bugs found.
```

**Output**:
```json
{
  "valid": false,
  "file": "incomplete-report.md",
  "sections": {
    "header": false,
    "executiveSummary": false,
    "detailedFindings": false,
    "validationResults": false,
    "nextSteps": false
  },
  "warnings": [],
  "errors": [
    "Missing header metadata (Generated, Status, Version)",
    "Missing section: Executive Summary",
    "Missing section: Detailed Findings",
    "Missing section: Validation Results",
    "Missing section: Next Steps"
  ]
}
```

### Example 3: Inconsistent Status

**Input**:
```
file_path: inconsistent-report.md
```

**File Content**:
```markdown
# Bug Report: 2025-10-17

**Status**: ✅ success

## Executive Summary

Failed to scan files.

## Validation Results

**Overall**: ❌ FAILED
```

**Output**:
```json
{
  "valid": false,
  "file": "inconsistent-report.md",
  "sections": {
    "header": true,
    "executiveSummary": true,
    "detailedFindings": false,
    "validationResults": true,
    "nextSteps": false
  },
  "warnings": [
    "Status inconsistency: Header shows success (✅) but validation shows failed (❌)"
  ],
  "errors": [
    "Missing section: Detailed Findings",
    "Missing section: Next Steps"
  ]
}
```

## Validation

- [ ] Checks all required sections present
- [ ] Validates header metadata
- [ ] Verifies status consistency
- [ ] Detects format issues
- [ ] Returns clear error messages
- [ ] Handles missing files gracefully

## Supporting Files

- `schema.json`: Report structure schema (see Supporting Files section)

Related Skills

validate-plan-file

164
from maslennikov-ig/claude-code-orchestrator-kit

Validate that orchestrator plan files conform to expected JSON schema. Use before workers read plan files or after orchestrators create them to ensure proper structure and required fields.

generate-report-header

164
from maslennikov-ig/claude-code-orchestrator-kit

Create standardized report headers with metadata for all agent-generated reports. Use when generating bug reports, security audits, dependency reports, or any worker output requiring consistent formatting.

Beads Issue Tracking Skill

164
from maslennikov-ig/claude-code-orchestrator-kit

> **Attribution**: [Beads](https://github.com/steveyegge/beads) by [Steve Yegge](https://github.com/steveyegge)

Workflow & ProductivityClaude

webapp-testing

164
from maslennikov-ig/claude-code-orchestrator-kit

Toolkit for interacting with and testing local web applications using Playwright. Supports verifying frontend functionality, debugging UI behavior, capturing browser screenshots, and viewing browser logs.

ux-researcher-designer

164
from maslennikov-ig/claude-code-orchestrator-kit

UX research and design toolkit for Senior UX Designer/Researcher including data-driven persona generation, journey mapping, usability testing frameworks, and research synthesis. Use for user research, persona creation, journey mapping, and design validation.

ui-design-system

164
from maslennikov-ig/claude-code-orchestrator-kit

UI design system toolkit for Senior UI Designer including design token generation, component documentation, responsive design calculations, and developer handoff tools. Use for creating design systems, maintaining visual consistency, and facilitating design-dev collaboration.

theme-factory

164
from maslennikov-ig/claude-code-orchestrator-kit

Toolkit for styling artifacts with a theme. These artifacts can be slides, docs, reportings, HTML landing pages, etc. There are 10 pre-set themes with colors/fonts that you can apply to any artifact that has been creating, or can generate a new theme on-the-fly.

systematic-debugging

164
from maslennikov-ig/claude-code-orchestrator-kit

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes

setup-knip

164
from maslennikov-ig/claude-code-orchestrator-kit

Install and configure Knip for dead code detection. Use before running dead-code-hunter or dependency-auditor to ensure Knip is available. Handles installation, configuration creation, and validation.

senior-prompt-engineer

164
from maslennikov-ig/claude-code-orchestrator-kit

World-class prompt engineering skill for LLM optimization, prompt patterns, structured outputs, and AI product development. Expertise in Claude, GPT-4, prompt design patterns, few-shot learning, chain-of-thought, and AI evaluation. Includes RAG optimization, agent design, and LLM system architecture. Use when building AI products, optimizing LLM performance, designing agentic systems, or implementing advanced prompting techniques.

senior-devops

164
from maslennikov-ig/claude-code-orchestrator-kit

Comprehensive DevOps skill for CI/CD, infrastructure automation, containerization, and cloud platforms (AWS, GCP, Azure). Includes pipeline setup, infrastructure as code, deployment automation, and monitoring. Use when setting up pipelines, deploying applications, managing infrastructure, implementing monitoring, or optimizing deployment processes.

senior-architect

164
from maslennikov-ig/claude-code-orchestrator-kit

Comprehensive software architecture skill for designing scalable, maintainable systems using ReactJS, NextJS, NodeJS, Express, React Native, Swift, Kotlin, Flutter, Postgres, GraphQL, Go, Python. Includes architecture diagram generation, system design patterns, tech stack decision frameworks, and dependency analysis. Use when designing system architecture, making technical decisions, creating architecture diagrams, evaluating trade-offs, or defining integration patterns.