mirror of
https://github.com/azaion/annotations.git
synced 2026-04-22 22:36:31 +00:00
Oleksandr Bezdieniezhnykh
58 lines
2.7 KiB
Markdown
58 lines
2.7 KiB
Markdown
# Step 1: Bootstrap Structure Plan (default mode only)
|
|
|
|
**Role**: Professional software architect
|
|
**Goal**: Produce `01_initial_structure.md` — the first task describing the project skeleton.
|
|
**Constraints**: This is a plan document, not code. The `/implement` skill executes it.
|
|
|
|
## Steps
|
|
|
|
1. Read `architecture.md`, all component specs, `system-flows.md`, `data_model.md`, and `deployment/` from DOCUMENT_DIR
|
|
2. Read problem, solution, and restrictions from `_docs/00_problem/` and `_docs/01_solution/`
|
|
3. Research best implementation patterns for the identified tech stack
|
|
4. Document the structure plan using `templates/initial-structure-task.md`
|
|
|
|
The bootstrap structure plan must include:
|
|
|
|
- Project folder layout with all component directories
|
|
- Shared models, interfaces, and DTOs
|
|
- Dockerfile per component (multi-stage, non-root, health checks, pinned base images)
|
|
- `docker-compose.yml` for local development (all components + database + dependencies)
|
|
- `docker-compose.test.yml` for blackbox test environment (blackbox test runner)
|
|
- `.dockerignore`
|
|
- CI/CD pipeline file (`.github/workflows/ci.yml` or `azure-pipelines.yml`) with stages from `deployment/ci_cd_pipeline.md`
|
|
- Database migration setup and initial seed data scripts
|
|
- Observability configuration: structured logging setup, health check endpoints (`/health/live`, `/health/ready`), metrics endpoint (`/metrics`)
|
|
- Environment variable documentation (`.env.example`)
|
|
- Test structure with unit and blackbox test locations
|
|
|
|
## Self-verification
|
|
|
|
- [ ] All components have corresponding folders in the layout
|
|
- [ ] All inter-component interfaces have DTOs defined
|
|
- [ ] Dockerfile defined for each component
|
|
- [ ] `docker-compose.yml` covers all components and dependencies
|
|
- [ ] `docker-compose.test.yml` enables blackbox testing
|
|
- [ ] CI/CD pipeline file defined with lint, test, security, build, deploy stages
|
|
- [ ] Database migration setup included
|
|
- [ ] Health check endpoints specified for each service
|
|
- [ ] Structured logging configuration included
|
|
- [ ] `.env.example` with all required environment variables
|
|
- [ ] Environment strategy covers dev, staging, production
|
|
- [ ] Test structure includes unit and blackbox test locations
|
|
|
|
## Save action
|
|
|
|
Write `todo/01_initial_structure.md` (temporary numeric name).
|
|
|
|
## Tracker action
|
|
|
|
Create a work item ticket for this task under the "Bootstrap & Initial Structure" epic. Write the work item ticket ID and Epic ID back into the task header.
|
|
|
|
## Rename action
|
|
|
|
Rename the file from `todo/01_initial_structure.md` to `todo/[TRACKER-ID]_initial_structure.md` (e.g., `todo/AZ-42_initial_structure.md`). Update the **Task** field inside the file to match the new filename.
|
|
|
|
## Blocking
|
|
|
|
**BLOCKING**: Present structure plan summary to user. Do NOT proceed until user confirms.
|