Test Plan Maker
A CLI tool to build structured test plans and write them to markdown files.
View on GitHubOverview
TestPlanMaker is a CLI tool I built to solve a recurring pain point in my day-to-day work: manually typing out test plans with a specific structure. Instead of repetitive typing, this tool guides you through creating comprehensive test plans and outputs them as markdown files.
Motivation
As a QA Engineer, I found myself repeatedly creating test plans with the same structure. Rather than copy-pasting templates, I wanted a streamlined tool that would:
- Guide me through all required fields
- Generate properly formatted markdown
- Support multiple validation types (UI, API, or both)
- Allow saving to custom paths or default to the desktop
Features
Interactive CLI Interface
The tool prompts for each field systematically:
- User Story Details: ID, link, stakeholders (PM, SE, QA), and components
- Test Plan Details: Validation type, automation requirements, and description
- Output Configuration: Custom file path or default to desktop
Validation Types
Supports three validation approaches:
- UI Validation
- API Validation
- UI & API Validation
Markdown Output
Generates clean, structured markdown files ready for documentation or test management tools.
Technical Stack
Built with Go, using:
- gcli for command-line interface structure
- charm.sh/glow for markdown preview
- Makefile for streamlined build and run commands
Usage
# Build and run
make compile
./BuildTestPlan
# Or run directly
make run
Future Enhancements
- JSON/YAML output formats
- Template customization
- Integration with test management systems
- Batch test plan generation
The project demonstrates my commitment to developer tooling and eliminating repetitive tasks through automation.