Initial commit: antigravity-ipa-workflow
This commit is contained in:
22
templates/docs/API_SPEC.md.template
Normal file
22
templates/docs/API_SPEC.md.template
Normal file
@@ -0,0 +1,22 @@
|
||||
# API Specification — [Project Name]
|
||||
|
||||
## 1. Overview
|
||||
|
||||
## 2. Authentication
|
||||
|
||||
## 3. Endpoints
|
||||
### E-01:
|
||||
- **Method:** GET/POST/PUT/DELETE
|
||||
- **Path:** /api/v1/...
|
||||
- **Request:**
|
||||
- **Response:**
|
||||
- **Maps to:** FR-xx
|
||||
|
||||
### E-02:
|
||||
|
||||
## 4. Error Handling
|
||||
|
||||
## 5. Rate Limiting
|
||||
|
||||
## 6. Traceability
|
||||
<!-- Map endpoints to FR-xx requirements from SRD -->
|
||||
18
templates/docs/DB_DESIGN.md.template
Normal file
18
templates/docs/DB_DESIGN.md.template
Normal file
@@ -0,0 +1,18 @@
|
||||
# Database Design — [Project Name]
|
||||
|
||||
## 1. Overview
|
||||
|
||||
## 2. Technology Choice
|
||||
|
||||
## 3. Schema
|
||||
### Table/Collection:
|
||||
- **Fields:**
|
||||
- **Indexes:**
|
||||
- **Relations:**
|
||||
|
||||
## 4. Migrations Strategy
|
||||
|
||||
## 5. Seed Data
|
||||
|
||||
## 6. Traceability
|
||||
<!-- Map tables/collections to FR-xx and E-xx -->
|
||||
18
templates/docs/SRD.md.template
Normal file
18
templates/docs/SRD.md.template
Normal file
@@ -0,0 +1,18 @@
|
||||
# SRD — [Project Name]
|
||||
|
||||
## 1. Overview
|
||||
|
||||
## 2. Business Context
|
||||
|
||||
## 3. Functional Requirements
|
||||
### FR-01:
|
||||
### FR-02:
|
||||
|
||||
## 4. Non-Functional Requirements
|
||||
### NFR-01:
|
||||
|
||||
## 5. Constraints
|
||||
|
||||
## 6. Assumptions
|
||||
|
||||
## 7. Glossary
|
||||
21
templates/docs/UI_SPEC.md.template
Normal file
21
templates/docs/UI_SPEC.md.template
Normal file
@@ -0,0 +1,21 @@
|
||||
# UI Specification — [Project Name]
|
||||
|
||||
## 1. Overview
|
||||
|
||||
## 2. Design System
|
||||
### 2.1 Color Palette
|
||||
### 2.2 Typography
|
||||
### 2.3 Spacing & Layout
|
||||
|
||||
## 3. Pages / Screens
|
||||
### S-01:
|
||||
### S-02:
|
||||
|
||||
## 4. Component Library
|
||||
|
||||
## 5. Responsive Breakpoints
|
||||
|
||||
## 6. Accessibility Requirements
|
||||
|
||||
## 7. Traceability
|
||||
<!-- Map screens to FR-xx requirements from SRD -->
|
||||
Reference in New Issue
Block a user