docs: initialize engineering starter kit

templates/PROJECT.template.md

@@ -0,0 +1,90 @@
+# {{PROJECT_NAME}}
+
+## Vision
+
+{{PROJECT_VISION}}
+
+## Goals
+
+- {{GOAL_1}}
+- {{GOAL_2}}
+- {{GOAL_3}}
+
+## Non-Goals
+
+- {{NON_GOAL_1}}
+- {{NON_GOAL_2}}
+
+## Functional Requirements
+
+| ID | Requirement | Priority |
+| --- | --- | --- |
+| FR-001 | {{FUNCTIONAL_REQUIREMENT}} | Must |
+
+## Non-Functional Requirements
+
+| Category | Requirement |
+| --- | --- |
+| Performance | {{PERFORMANCE_REQUIREMENT}} |
+| Security | {{SECURITY_REQUIREMENT}} |
+| Availability | {{AVAILABILITY_REQUIREMENT}} |
+| Maintainability | {{MAINTAINABILITY_REQUIREMENT}} |
+
+## Tech Stack
+
+| Area | Choice |
+| --- | --- |
+| Language | {{LANGUAGE}} |
+| Framework | {{FRAMEWORK}} |
+| Database | {{DATABASE}} |
+| Deployment | {{DEPLOYMENT}} |
+
+## Runtime
+
+| Environment | URL or Entry Point | Notes |
+| --- | --- | --- |
+| Local | {{LOCAL_URL}} | {{LOCAL_NOTES}} |
+| Staging | {{STAGING_URL}} | {{STAGING_NOTES}} |
+| Production | {{PRODUCTION_URL}} | {{PRODUCTION_NOTES}} |
+
+## Infrastructure
+
+- Hosting: {{HOSTING}}
+- Storage: {{STORAGE}}
+- Network: {{NETWORK}}
+- Secrets: {{SECRETS}}
+
+## Authentication And Authorization
+
+- Authentication: {{AUTHENTICATION}}
+- Authorization: {{AUTHORIZATION}}
+- Roles or policies: {{ROLES_OR_POLICIES}}
+
+## Logging And Monitoring
+
+- Logging: {{LOGGING}}
+- Monitoring: {{MONITORING}}
+- Alerting: {{ALERTING}}
+
+## Testing
+
+- Unit tests: {{UNIT_TESTS}}
+- Integration tests: {{INTEGRATION_TESTS}}
+- End-to-end tests: {{E2E_TESTS}}
+- Manual checks: {{MANUAL_CHECKS}}
+
+## CI/CD
+
+- CI: {{CI}}
+- CD: {{CD}}
+- Required checks: {{REQUIRED_CHECKS}}
+
+## Roadmap
+
+| Milestone | Outcome |
+| --- | --- |
+| {{MILESTONE}} | {{OUTCOME}} |
+
+## Open Questions
+
+- {{OPEN_QUESTION}}