Overview

Use this folder as the starting point for a new DocEngineering skill, providing prerequisites, a structured workflow, and a strict output format. It guides discovery (Scout), analysis, execution of deterministic scripts, and validation, with explicit error handling.

How This Skill Works

The template uses Read/Grep/Find to scout and read only the minimum necessary files. It executes deterministic scripts under {baseDir}/scripts, and enforces a strict output format defined in {baseDir}/assets or a JSON schema, with validation steps before returning results.

When to Use It

• Starting a new DocEngineering skill from scratch
• Ensuring portability with relative paths via {baseDir}
• Enforcing reproducible builds with deterministic scripts
• Defining and validating strict output formats
• Gracefully handling missing inputs or hard-gate failures

Quick Start

1. Step 1: Scout relevant files with Grep/find to locate inputs
2. Step 2: Analyze the minimal required files with Read
3. Step 3: Implement deterministic scripts under {baseDir}/scripts and define outputs in {baseDir}/assets or a JSON schema; run validation

Best Practices

• Confirm required input paths exist before proceeding
• Prefer relative paths using {baseDir} for portability
• Keep scripts under {baseDir}/scripts deterministic and idempotent
• Define outputs in {baseDir}/assets and/or a JSON schema
• Use explicit validation and clear blockers when inputs fail

Example Use Cases

• Scouting a new skill's files with Grep to identify relevant docs
• Reading only the minimum necessary files during Analyze
• Running a validation script before returning results
• Using EXIT_BLOCKED with a blockers list when a gate fails
• Packaging outputs under {baseDir}/assets for downstream use

Frequently Asked Questions