Skip to content

QUICKSTART.md

Latest commit

 

History

History
89 lines (65 loc) · 2.73 KB

QUICKSTART.md

File metadata and controls

89 lines (65 loc) · 2.73 KB

Quick Start Guide

Prerequisites

  • Claude Code CLI installed
  • Node.js 18+ (for executive briefing deck generation)
  • Git

Step-by-Step

1. Create Your Repository

# From GitHub: Click "Use this template" → "Create a new repository"
# Or clone directly:
git clone https://github.com/zircote/github4farms.git my-project
cd my-project

2. Define Your Project Context

Option A: Interactive Interview (Recommended)

Run the guided elicitation in Claude Code:

/project-context

This walks you through a structured interview to build PROJECT-CONTEXT.md.

Option B: Manual Editing

Edit PROJECT-CONTEXT.md directly with your project details.

The more data you provide, the more specific the artifacts will be.

3. Generate All Artifacts

Open Claude Code and run:

/project-architect Generate complete project planning artifacts based on PROJECT-CONTEXT.md

This will execute all 16 skills in the correct dependency order and produce the complete artifact set.

4. Generate Individual Artifacts (Optional)

If you only need specific artifacts:

Command Output
/project-context Interactive context elicitation
/domain-research Domain research report
/project-plan Master project plan
/gantt-chart Timeline with SVG
/jira-structure Epic/story breakdown
/raci-chart Responsibility matrix
/risk-register Risk management plan
/severity-classification Priority framework
/best-practices Industry standards
/success-metrics KPIs and measurement
/runbook-template Operational procedures
/readme-generator GitHub landing page
/changelog Version history
/svg-gantt-generator SVG Gantt chart
/infographic-generator Visual summary
/executive-briefing PowerPoint deck
/dependency-analyzer Critical path analysis

5. Build Executive Deck (Optional)

cd workspace
npm install
node generate-assets.js
node build-deck.js

6. Review and Customize

All generated artifacts are in markdown format and can be edited directly. The SVG graphics can be regenerated by re-running the relevant skills.

Tips

  • Provide data: The more quantitative data you provide in PROJECT-CONTEXT.md, the more data-driven the artifacts will be
  • Iterate: Run individual skills to regenerate specific artifacts after making changes
  • Customize colors: Edit .claude/skills/svg-gantt-generator/SKILL.md to change the phase color scheme
  • Add frameworks: Edit .claude/skills/domain-research/SKILL.md to add industry-specific sources
  • Scale complexity: The system adapts to project size (small: 5-8 epics, medium: 10-15, large: 15-25)