create-usage

Generates execution guides with prerequisites, run patterns, verification, and troubleshooting sections.

Updated Jan 28, 2026
One-click install
npx skills add https://github.com/ttphats/project-detedxs26 --skill create-usage-ttphats
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: create-usage
Source: https://github.com/ttphats/project-detedxs26/tree/main/.augment/skills/custom/create-usage
Command: npx skills add https://github.com/ttphats/project-detedxs26 --skill create-usage-ttphats

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Teams often lack consistent operational documentation for jobs, tests, and scripts, forcing engineers to guess commands, flags, and failure recovery steps. This Skill produces a standardized USAGE.md execution guide so anyone can run, verify, and roll back a process without tribal knowledge. ## Core Features & Use Cases - Structured Execution Guide Generation: Produces a USAGE.md with prerequisites checklist, three execution patterns (basic, options, production), expected output samples, and exit codes. - Operational Safety Sections: Includes verification steps, monitoring endpoints, troubleshooting commands, rollback procedures, and a common flags reference table. - Reusable Template: Ships a fill-in template at templates/USAGE-template.md covering jobs, tests, scripts, and examples categories. - Use Case: After writing a Spark job or test suite, ask for a usage guide and receive a complete document covering dry-run, sample-run, and production-run patterns with verification and rollback instructions. ## Quick Start Ask the assistant to create a usage guide for your Spark job, test suite, or script, providing its command, flags, and prerequisites.

Frequently Asked Questions about create-usage

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

FAQPage Schema
How do I create a usage guide for a script or job?▼

Provide the target command, its common flags, and prerequisites, then request a usage guide. The Skill generates a USAGE.md with three execution patterns, expected outputs, verification steps, troubleshooting, and rollback procedures.

What sections should an execution guide include?▼

A complete execution guide includes a prerequisites checklist, multiple run patterns with expected output, verification commands, monitoring endpoints, troubleshooting checks, rollback steps, and a flags reference table. The template enforces all of these sections.

Can I document test suites and Spark jobs with the same template?▼

Yes, the template supports jobs, tests, scripts, and examples categories. Each pattern adapts to the target type, such as dry run for jobs or limited-scope runs for test suites.

What are common mistakes when writing execution documentation?▼

Common anti-patterns include missing prerequisites, documenting only one execution pattern, omitting expected output samples, and skipping verification or troubleshooting sections. The Skill's quality checklist validates against each of these.

Does the generated guide include rollback procedures?▼

Yes, the template includes a rollback section with commands to stop the process, clean up output artifacts, and reset state. It is marked optional and applies when the execution modifies data or state.