Guides

Practical module-owned guides for official bundles, adapters, publishing, and deep workflow documentation.

Available Guides

Primary Use Case: Brownfield Modernization ⭐

• Brownfield Engineer Guide ⭐ PRIMARY - Complete guide for modernizing legacy code
• The Brownfield Journey ⭐ PRIMARY - Step-by-step modernization workflow
• Brownfield ROI ⭐ - Calculate time and cost savings
• Brownfield FAQ ⭐ - Common questions about brownfield modernization

Secondary Use Case: Spec-Kit & OpenSpec Integration

• Spec-Kit Journey - Adding enforcement to Spec-Kit projects
• Spec-Kit Comparison - Understand when to use each tool
• OpenSpec Journey 🆕 ⭐ START HERE - Complete integration guide with visual workflows: DevOps export (✅), bridge adapter (⏳), brownfield modernization
• Use Cases - Real-world scenarios (brownfield primary, Spec-Kit secondary)

General Guides

• Workflows - Common daily workflows
• IDE Integration - Set up slash commands in your IDE
• CoPilot Mode - Using --mode copilot on CLI commands
• DevOps Adapter Integration 🆕 - Integrate with GitHub Issues, Azure DevOps, Linear, Jira for backlog tracking
• Backlog Refinement 🆕 NEW FEATURE - AI-assisted template-driven refinement for standardizing work items with persona/framework filtering, sprint/iteration support, and DoR validation
• Specmatic Integration - API contract testing with Specmatic (validate specs, generate tests, mock servers)
• Troubleshooting - Common issues and solutions
• Installing Modules - Install, list, show, search, enable/disable, uninstall, and upgrade modules
• Module Marketplace - Discovery priority, trust vs origin semantics, and security model
• Custom registries - Add, list, remove registries; trust levels and priority
• Publishing modules - Package, sign, and publish modules to a registry
• Module Signing and Key Rotation - Public key placement, signing workflow, CI verification, rotation, and revocation runbook
• Competitive Analysis - How SpecFact compares to other tools
• Operational Modes - CI/CD vs CoPilot modes (reference)

Quick Start

Modernizing Legacy Code? ⭐ PRIMARY

1. Integration Showcases ⭐ START HERE - Real bugs fixed via VS Code, Cursor, GitHub Actions integrations
2. Brownfield Engineer Guide ⭐ - Complete modernization guide
3. The Brownfield Journey ⭐ - Step-by-step workflow
4. Use Cases - Brownfield ⭐ - Real-world examples

For IDE Users

1. IDE Integration - Set up slash commands in your IDE
2. Use Cases - See real-world examples

For CLI Users

1. CoPilot Mode - Using --mode copilot for enhanced prompts
2. Operational Modes - Understanding CI/CD vs CoPilot modes
3. DevOps Adapter Integration 🆕 - GitHub Issues and backlog tracking
4. Backlog Refinement 🆕 NEW - AI-assisted template-driven refinement with filtering, DoR validation, and preview/write safety
5. Specmatic Integration - API contract testing workflow

For Spec-Kit & OpenSpec Users (Secondary)

1. Tutorial: Using SpecFact with OpenSpec or Spec-Kit ⭐ START HERE - Complete beginner-friendly step-by-step tutorial
2. Spec-Kit Journey - Add enforcement to Spec-Kit projects
3. OpenSpec Journey 🆕 ⭐ - Complete OpenSpec integration guide with DevOps export and visual workflows
4. DevOps Adapter Integration 🆕 - Export change proposals to GitHub Issues
5. Use Cases - Spec-Kit Migration - Step-by-step migration

Need Help?

• 💬 GitHub Discussions
• 🐛 GitHub Issues
• 📧 [email protected]