115 lines
3.1 KiB
Bash
Executable File
115 lines
3.1 KiB
Bash
Executable File
#!/bin/bash
|
|
|
|
# List Available Spec Templates
|
|
|
|
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
|
TEMPLATES_DIR="$SCRIPT_DIR/../templates"
|
|
|
|
# Color codes
|
|
GREEN='\033[0;32m'
|
|
BLUE='\033[0;34m'
|
|
YELLOW='\033[1;33m'
|
|
NC='\033[0m'
|
|
|
|
echo ""
|
|
echo -e "${BLUE}📚 AVAILABLE SPECIFICATION TEMPLATES${NC}"
|
|
echo "====================================="
|
|
echo ""
|
|
|
|
if [ ! -d "$TEMPLATES_DIR" ]; then
|
|
echo "Note: Templates will be synced from project templates directory"
|
|
echo ""
|
|
fi
|
|
|
|
# Display templates by category
|
|
echo -e "${BLUE}📋 BY CATEGORY${NC}"
|
|
echo ""
|
|
|
|
echo -e "${YELLOW}Requirements & Business:${NC}"
|
|
echo " • business-requirement"
|
|
echo " Document business needs and customer problems"
|
|
echo ""
|
|
echo " • technical-requirement"
|
|
echo " How to build what business requires"
|
|
echo ""
|
|
|
|
echo -e "${YELLOW}Architecture & Design:${NC}"
|
|
echo " • design-document"
|
|
echo " Architecture and technical design decisions"
|
|
echo ""
|
|
echo " • api-contract"
|
|
echo " API endpoint specifications and contracts"
|
|
echo ""
|
|
echo " • data-model"
|
|
echo " Entity definitions and database schemas"
|
|
echo ""
|
|
|
|
echo -e "${YELLOW}Implementation & Operations:${NC}"
|
|
echo " • component"
|
|
echo " System component specifications"
|
|
echo ""
|
|
echo " • plan"
|
|
echo " Implementation roadmap and phases"
|
|
echo ""
|
|
echo " • milestone"
|
|
echo " Delivery milestones and checkpoints"
|
|
echo ""
|
|
|
|
echo -e "${YELLOW}Process & Deployment:${NC}"
|
|
echo " • flow-schematic"
|
|
echo " Business process flows and workflows"
|
|
echo ""
|
|
echo " • deployment-procedure"
|
|
echo " Production deployment steps"
|
|
echo ""
|
|
echo " • configuration-schema"
|
|
echo " Configuration specifications"
|
|
echo ""
|
|
|
|
echo -e "${BLUE}📝 USAGE${NC}"
|
|
echo "--------"
|
|
echo ""
|
|
echo "To create a new spec from a template, use:"
|
|
echo -e " ${GREEN}./scripts/generate-spec.sh <template-name> <output-path>${NC}"
|
|
echo ""
|
|
echo "Example:"
|
|
echo -e " ${GREEN}./scripts/generate-spec.sh business-requirement specs/user-export.md${NC}"
|
|
echo ""
|
|
|
|
echo -e "${BLUE}🎯 ID CONVENTIONS${NC}"
|
|
echo "------------------"
|
|
echo ""
|
|
echo "• Business Requirement: brd-XXX-descriptive-slug"
|
|
echo " Example: brd-001-user-export-pdf"
|
|
echo ""
|
|
echo "• Technical Requirement: prd-XXX-descriptive-slug"
|
|
echo " Example: prd-001-export-service"
|
|
echo ""
|
|
echo "• Design Document: des-XXX-descriptive-slug"
|
|
echo " Example: des-001-microservices-architecture"
|
|
echo ""
|
|
echo "• API Contract: api-XXX-descriptive-slug"
|
|
echo " Example: api-001-user-service"
|
|
echo ""
|
|
echo "• Data Model: data-XXX-descriptive-slug"
|
|
echo " Example: data-001-user-schema"
|
|
echo ""
|
|
echo "• Component: cmp-XXX-descriptive-slug"
|
|
echo " Example: cmp-001-auth-service"
|
|
echo ""
|
|
echo "• Plan: pln-XXX-descriptive-slug"
|
|
echo " Example: pln-001-migration-roadmap"
|
|
echo ""
|
|
echo "• Milestone: mls-XXX-descriptive-slug"
|
|
echo " Example: mls-001-phase-1-delivery"
|
|
echo ""
|
|
echo "• Flow Schematic: flow-XXX-descriptive-slug"
|
|
echo " Example: flow-001-user-signup"
|
|
echo ""
|
|
echo "• Deployment Procedure: deploy-XXX-descriptive-slug"
|
|
echo " Example: deploy-001-staging-release"
|
|
echo ""
|
|
echo "• Configuration Schema: config-XXX-descriptive-slug"
|
|
echo " Example: config-001-app-settings"
|
|
echo ""
|