This guide assumes you have already installed SoftArchitect AI and ingested the knowledge base. If you haven’t, start with the quickstart and knowledge ingestion guides first.
The Guided Architectural Workflow
SoftArchitect AI structures every project around a six-phase Guided Architectural Workflow:Step-by-step walkthrough
Launch SoftArchitect AI
Start the Flutter desktop application. On Linux you can launch it directly from the terminal:The app connects to the backend API at
http://localhost:8000. Confirm the status indicator in the bottom bar shows Connected before proceeding.Create a new project
Click New project on the dashboard. You will be prompted for:
- Project name — a short identifier (e.g.,
inventory-service) - Output folder — where generated documents will be saved
Context gathering (Phase 1)
The AI begins the interview by asking about your project’s context. Expect questions covering:
- Domain — what business problem are you solving?
- Team size — solo developer, small team, or enterprise?
- Constraints — budget, timeline, compliance requirements (GDPR, HIPAA, etc.)
- Target users — who will use the system and how?
| Document | Purpose |
|---|---|
PROJECT_MANIFESTO | Mission, values, and success criteria |
DOMAIN_LANGUAGE | Ubiquitous language glossary (DDD) |
USER_JOURNEY_MAP | Personas and user flow diagrams |
Requirements analysis (Phase 2)
The AI transforms your business description into structured technical requirements:
- Prioritised user stories (exported as a JSON backlog)
- Functional and non-functional requirements
- Security and privacy policy grounded in OWASP Top 10
- Compliance matrix (GDPR/CCPA/WCAG)
The AI will ask stack-specific questions if you have selected a Tech Pack. For example, if you chose the Flutter pack, it will ask about target platforms and offline requirements.
Architecture design (Phase 3)
This is the core phase. The AI designs the technical foundation by producing six documents:
All recommendations enforce SOLID principles and Clean Architecture (hexagonal ports-and-adapters). The RAG engine retrieves relevant rules from the Tech Packs knowledge base to back every recommendation with concrete evidence.
| Document | Key deliverable |
|---|---|
TECH_STACK_DECISION | Recommended stack with trade-off analysis |
DATA_MODEL_SCHEMA | Entity-relationship diagram and table schemas |
PROJECT_STRUCTURE_MAP | Directory tree with Clean Architecture layers |
API_INTERFACE_CONTRACT | OpenAPI-style endpoint specifications |
SECURITY_THREAT_MODEL | STRIDE threat matrix |
ARCH_DECISION_RECORDS | ADR log (why X was chosen over Y) |
UX/UI planning (Phase 4)
With the architecture settled, the AI moves to user experience:
- Design system — component library, typography, colour tokens
- UI wireframes & flows — screen-by-screen mockup descriptions
- Accessibility guide — WCAG 2.1 AA compliance checklist
Planning (Phase 5)
The AI generates a development backlog and operational plan:
- Roadmap — phased release milestones tied to user stories
- Testing strategy — test pyramid with coverage targets (≥80%)
- CI/CD pipeline — GitHub Actions workflow definitions
- Deployment infrastructure — Docker Compose configuration
ROOT synthesis (Phase 6)
The final phase synthesises everything into four agent-ready files:
These files are generated last intentionally. With 20+ documents in the RAG context window, the AI synthesises accurate, hallucination-free summaries rather than guessing from an empty slate.
| File | Purpose |
|---|---|
RULES.md | Code quality rules and conventions derived from your actual tech stack |
CONTRIBUTING.md | PR process, branching strategy, and project conventions |
AGENTS.md | Team structure, roles, and responsibilities |
README.md | Complete project overview with quick-start guide |
What you get
After completing all six phases, your output folder contains 24 documents organised into phases:Tips for better recommendations
Pick the right Tech Pack
Selecting a Tech Pack before you start tailors every question and recommendation to your stack. A Flutter + FastAPI + Firebase project gets different architecture patterns than a Spring Boot + PostgreSQL one.
Be precise about constraints
Mention hard constraints early: offline-first, GDPR data residency, sub-200ms latency SLA. The AI uses these to eliminate unsuitable patterns before recommending anything.
Iterate within a phase
You can ask the AI to revise any document before moving to the next phase. Changing the data model in Phase 3 is free; changing it after Phase 5 generates more rework.
Tune context window for your model
If you are running a local Ollama model with an 8K context window, set
LLM_MAX_PROMPT_CHARS=30000 and RAG_MAX_CHUNKS=2 in your .env to prevent out-of-memory errors.