ai-spector 0.1.1

package/_templates/basic_design/detail-screen-template.md

@@ -0,0 +1,281 @@
+# Screen Detail:
+
+> This document provides detailed layout, component, and interaction specifications for each screen. For the screen map and design system, see the Screen Map (List Screen) document. Use one section per screen; duplicate the structure below for each screen in the Screen Index.
+
+**Source Requirements:** SRS Section 6.1 (User Interfaces)
+
+---
+
+## 1. Screen:
+
+**Purpose:**
+
+> Describe the purpose of this screen and what users can accomplish.
+
+**User Role:** 
+
+**Source Requirements:** SRS Section <X.X> - 
+
+### 1.1 Visual Wireframe
+
+> Use ASCII art or grid-based layout to show the visual structure. You can also reference an image file or Figma link.
+
+**Option 1: ASCII Wireframe**
+
+```
+┌─────────────────────────────────────────────────────────┐
+│  [Logo]                    [User Menu] [Notifications]  │ ← Header (60px)
+├──────────┬───────────────────────────────────────────────┤
+│          │                                               │
+│  Nav     │          Main Content Area                    │
+│  Menu    │          ┌─────────────────┐                 │
+│          │          │  Card/Component │                 │
+│  Item 1  │          │                 │                 │
+│  Item 2  │          └─────────────────┘                 │
+│  Item 3  │          ┌─────────────────┐                 │
+│          │          │  Card/Component │                 │
+│          │          │                 │                 │
+│          │          └─────────────────┘                 │
+│          │                                               │
+├──────────┴───────────────────────────────────────────────┤
+│  Footer Content                                           │ ← Footer (40px)
+└─────────────────────────────────────────────────────────┘
+```
+
+**Option 2: Grid Layout Description**
+
+```
+┌─────────────────────────────────────────────────────────┐
+│ HEADER (100% width, 60px height)                        │
+│ [Logo: 200px] [Spacer] [User Menu: 150px] [Notif: 50px] │
+├─────────────────────────────────────────────────────────┤
+│ SIDEBAR │ MAIN CONTENT (flex: 1)                         │
+│ (250px) │ ┌───────────────────────────────────────────┐ │
+│         │ │ STATS CARDS (3 columns, equal width)        │ │
+│ Nav     │ │ [Card 1] [Card 2] [Card 3]                │ │
+│ Menu    │ └───────────────────────────────────────────┘ │
+│         │ ┌───────────────────────────────────────────┐ │
+│ Item 1  │ │ TABLE/LIST (full width)                    │ │
+│ Item 2  │ │ [Row 1] [Row 2] [Row 3]                   │ │
+│         │ └───────────────────────────────────────────┘ │
+└─────────┴───────────────────────────────────────────────┘
+```
+
+**Option 3: Image Reference**
+
+> **Wireframe Image:** `[screens/screen-name-wireframe.png]` or `[Figma Link]`
+>
+> **High-Fidelity Mockup:** `[screens/screen-name-mockup.png]` or `[Figma Link]`
+
+### 1.2 Layout Structure
+
+
+| Component        | Position        | Width/Height | Description |
+| ---------------- | --------------- | ------------ | ----------- |
+| **Header**       | Top             | 100% × 60px  |             |
+| **Navigation**   | <Left/Side/Top> | 250px × auto |             |
+| **Main Content** | Center          | flex: 1      |             |
+| **Sidebar**      | <Right/Left>    | 300px × auto |             |
+| **Footer**       | Bottom          | 100% × 40px  |             |
+
+
+### 1.3 Component Details
+
+**Header:**
+
+- Logo: 
+- User menu: 
+- Notifications:
+
+**Main Content Area:**
+
+
+| Component          | Description | Visual Style |
+| ------------------ | ----------- | ------------ |
+| **Component Name** | Description | Style notes  |
+
+
+**Key Components:**
+
+**Component Name:**
+
+- **Purpose:** What it does
+- **Visual Representation:**
+  ```
+  ┌─────────────────────────────┐
+  │ [Icon] Title Text            │
+  │ ───────────────────────────  │
+  │ Content area                 │
+  │ [Button] [Button]            │
+  └─────────────────────────────┘
+  ```
+- **Elements:**
+  - <Element 1>:  (Position: <top/left/right>, Size: )
+  - <Element 2>:  (Position: <top/left/right>, Size: )
+- **Visual Style:**
+  - Background: 
+  - Border: <1px solid color>
+  - Padding: <16px>
+  - Margin: <8px>
+  - Border radius: <4px>
+- **Dimensions:** <Width × Height>
+- **Interaction:**
+
+### 1.4 User Interactions
+
+**Primary Actions:**
+
+- <Action 1>: 
+- <Action 2>:
+
+**Navigation Flow:**
+
+- From this screen, users can navigate to:
+  - <Screen/Page>: 
+  - <Screen/Page>:
+
+**Form Layout (if applicable):**
+
+```
+┌─────────────────────────────────────┐
+│ Form Title                           │
+│ ───────────────────────────────────  │
+│ [Label]                              │
+│ ┌─────────────────────────────────┐ │
+│ │ Input Field                     │ │
+│ └─────────────────────────────────┘ │
+│ [Label]                              │
+│ ┌─────────────────────────────────┐ │
+│ │ Dropdown/Select                 │ │
+│ └─────────────────────────────────┘ │
+│                                      │
+│ [Cancel] [Submit Button]             │
+└─────────────────────────────────────┘
+```
+
+**Form Interactions:**
+
+- :
+- :
+
+### 1.5 Field Validation and Default Data
+
+> This section documents validation rules and default values for all input fields on this screen.
+>
+> **Note:** If this screen has no input fields or forms, this section can be omitted or marked as "N/A - No input fields on this screen."
+
+**Field Validation and Default Data:**
+
+
+| Field Name | Field Type                        | Required | Default Value              | Default Source                          | Validation Rules | Error Messages | Notes |
+| ---------- | --------------------------------- | -------- | -------------------------- | --------------------------------------- | ---------------- | -------------- | ----- |
+|            | <Text/Email/Number/Date/Dropdown> | <Yes/No> | <Default value or "Empty"> | <Auto-generated/System/User preference> |                  |                |       |
+
+
+**Detailed Field Information:**
+
+**:**
+
+- **Type:** 
+- **Required:** <Yes/No>
+- **Default Value:** <Value or "Empty">
+- **Default Source:** 
+- **Min Length:**  characters
+- **Max Length:**  characters
+- **Pattern/Format:** 
+- **Custom Validation:** 
+- **Error Messages:**
+  - Required: ""
+  - Format: ""
+  - Custom: ""
+- **Real-time Validation:** <Yes/No - validates on blur/on change>
+- **Dependencies:** 
+- **Notes:**
+
+ **(Dropdown):**
+
+- **Type:** Dropdown/Select
+- **Required:** <Yes/No>
+- **Default Value:** 
+- **Default Source:** <System/First option/User preference>
+- **Options Source:** <Static list/Dynamic from API/User selection>
+- **Options:**
+  - : -
+  - : -
+- **Dependencies:** 
+- **Validation Rules:** 
+- **Error Messages:**
+
+---
+
+## 2. Screen:
+
+**Purpose:**
+
+> Describe the purpose of this screen.
+
+**User Role:** 
+
+**Source Requirements:** SRS Section <X.X>
+
+### 2.1 Visual Wireframe
+
+```
+┌─────────────────────────────────────────────────────────┐
+│ [Screen Layout - Use ASCII art or reference image]       │
+└─────────────────────────────────────────────────────────┘
+```
+
+**Wireframe Image:** `[screens/screen-name-wireframe.png]` or `[Figma Link]`
+
+### 2.2 Layout Structure
+
+
+| Component | Position | Width/Height | Description |
+| --------- | -------- | ------------ | ----------- |
+|           |          |              |             |
+
+
+### 2.3 Component Details
+
+**:**
+
+- **Purpose:** 
+- **Visual Representation:**
+  ```
+  ┌─────────────────────────────┐
+  │ Component Layout             │
+  └─────────────────────────────┘
+  ```
+- **Elements:**
+  - <Element 1>
+  - <Element 2>
+- **Visual Style:** 
+- **Dimensions:** <Width × Height>
+- **Interaction:**
+
+### 2.4 User Interactions
+
+**Primary Actions:**
+
+- <Action 1>
+- <Action 2>
+
+---
+
+## 3. Screen:
+
+**Purpose:**
+
+> Describe the purpose of this screen.
+
+**User Role:** 
+
+### 3.1 Visual Wireframe
+
+### 3.2 Layout Structure
+
+---
+
+> Repeat the same section structure (Screen name → Wireframe → Layout → Component Details → User Interactions → Field Validation if applicable) for each additional screen in the Screen Index.
+

package/_templates/basic_design/list-api-template.md

@@ -0,0 +1,130 @@
+# API List: 
+
+> This document provides the API overview, authentication, and a summary list of all endpoints. For detailed request/response specifications per endpoint, see the Detail API document.
+
+**Source Requirements:** SRS Section 4 (System Features), Section 6.2 (Software Interfaces)
+
+---
+
+## 1. API Overview
+
+**Base URL:** `<https://api.example.com/v1>`
+
+**API Version:** `v1.0`
+
+**Protocol:** `HTTPS`
+
+**Authentication:** <JWT/OAuth2/API Key>
+
+**Content Type:** `application/json`
+
+**Source Requirements:**
+
+- SRS Section 4: 
+- SRS Section 6.2: 
+- SRS Section 7.3: 
+
+---
+
+## 2. Authentication
+
+**Method:** <JWT Bearer Token / OAuth2 / API Key>
+
+**How to Authenticate:**
+
+> Describe the authentication flow.
+
+**Token Format:**
+
+> Describe token structure if applicable.
+
+**Example:**
+
+```http
+Authorization: Bearer <token>
+```
+
+**Token Expiration:**
+
+> Describe token expiration and refresh mechanism.
+
+---
+
+## 3. Endpoint Summary
+
+
+| Method   | Endpoint         | Description | Authentication |
+| -------- | ---------------- | ----------- | -------------- |
+| `POST`   | `/resource`      |             | Required       |
+| `GET`    | `/resource`      |             | Required       |
+| `GET`    | `/resource/{id}` |             | Required       |
+| `PUT`    | `/resource/{id}` |             | Required       |
+| `DELETE` | `/resource/{id}` |             | Required       |
+
+
+> Add one row per endpoint. For detailed specifications (request/response schemas, path/query params), see the Detail API document.
+
+---
+
+## 4. Pagination
+
+**Query Parameters:**
+
+- `page`: Page number (default: 1)
+- `per_page`: Items per page (default: 20, max: 100)
+
+**Response Format:**
+
+```json
+{
+  "data": [...],
+  "pagination": {
+    "page": 1,
+    "per_page": 20,
+    "total": 100,
+    "total_pages": 5
+  }
+}
+```
+
+---
+
+## 5. Filtering and Sorting
+
+**Query Parameters:**
+
+- `filter[field]`: Filter by field value
+- `sort`: Sort field and direction (e.g., `created_at:desc`)
+
+**Examples:**
+
+```
+GET /resource?filter[status]=active&sort=created_at:desc
+```
+
+---
+
+## 6. OpenAPI / Specification Reference
+
+> Reference or include link to OpenAPI/Swagger specification file.
+
+**Location:** `<api-spec.yaml>`
+
+**Note:** For detailed endpoint specifications, see the Detail API document.
+
+---
+
+## 7. Notes
+
+**API Versioning Strategy:**
+
+> Describe versioning approach.
+
+**Deprecation Policy:**
+
+> Describe how deprecated endpoints are handled.
+
+**Testing:**
+
+> Reference API testing documentation or Postman collection.
+

package/_templates/basic_design/list-screen-template.md

@@ -0,0 +1,242 @@
+# Screen Map: <Project Name>
+
+> This document provides the design system overview, screen map (navigation flow), screen index, and common UI building blocks. For detailed layout and interactions per screen, see the Detail Screen document for each screen.
+
+**Source Requirements:** SRS Section 6.1 (User Interfaces)
+
+---
+
+## 1. Design System Overview
+
+**Color Palette:**
+- Primary: <Color>
+- Secondary: <Color>
+- Accent: <Color>
+- Background: <Color>
+- Text: <Color>
+
+**Typography:**
+- Headings: <Font family, sizes>
+- Body: <Font family, sizes>
+- Buttons: <Font family, sizes>
+
+**Spacing:**
+- Base unit: <8px/4px>
+- Component spacing: <Guidelines>
+
+---
+
+## 2. Screen Map (Navigation Flow)
+
+> This diagram shows the relationships and navigation flow between all screens in the application.
+
+**Mermaid Flowchart:**
+```mermaid
+flowchart TD
+    A[Login] --> B[Dashboard]
+    B --> C[Screen 1]
+    B --> D[Screen 2]
+    B --> E[Screen 3]
+    B --> F[Screen 4]
+    C --> G[Screen 5]
+    D --> G
+    E --> G
+    F --> G
+    G --> B
+```
+
+**Detailed Navigation Map:**
+```
+┌─────────────────────────────────────────────────────────────────┐
+│                    Screen Relationship Map                      │
+└─────────────────────────────────────────────────────────────────┘
+
+Entry Point: Login Screen
+    │
+    ├─→ Dashboard (Main Hub)
+    │   │
+    │   ├─→ Screen 1 (via Navigation Menu)
+    │   │   ├─→ Screen 1A (via Action Button)
+    │   │   └─→ Screen 1B (via Action Button)
+    │   │
+    │   ├─→ Screen 2 (via Navigation Menu)
+    │   │   └─→ Screen 2A (via Modal/Detail View)
+    │   │
+    │   ├─→ Screen 3 (via Navigation Menu)
+    │   │
+    │   └─→ Screen 4 (via Navigation Menu)
+    │       └─→ Screen 4A (via Action Button)
+    │
+    └─→ [Other Entry Points]
+```
+
+**Navigation Patterns:**
+- **Primary Navigation:** <Menu type - Sidebar/Top Nav/Bottom Nav>
+- **Secondary Navigation:** <Breadcrumbs/Back buttons>
+- **Modal/Overlay Screens:** <List screens that appear as modals>
+- **Deep Links:** <Screens accessible via direct URL>
+
+**User Role-Based Navigation:**
+- **<Role 1>:** <List accessible screens>
+- **<Role 2>:** <List accessible screens>
+- **<Role 3>:** <List accessible screens>
+
+---
+
+## 3. Quick Reference: Common UI Elements
+
+> Use these ASCII patterns as building blocks when describing components in detail screens.
+
+**Card Component:**
+```
+┌─────────────────────────────┐
+│ [Icon] Title                 │
+│ ───────────────────────────  │
+│ Content text here            │
+│ [Action Button]              │
+└─────────────────────────────┘
+```
+
+**Button:**
+```
+┌──────────────┐
+│ Button Text  │
+└──────────────┘
+```
+
+**Input Field:**
+```
+┌──────────────────────────────┐
+│ Label                        │
+│ ┌──────────────────────────┐ │
+│ │ Input text here          │ │
+│ └──────────────────────────┘ │
+└──────────────────────────────┘
+```
+
+**Table/List:**
+```
+┌──────┬──────────┬──────────┐
+│ Col1 │ Col2     │ Col3     │
+├──────┼──────────┼──────────┤
+│ Data │ Data     │ Data     │
+│ Data │ Data     │ Data     │
+└──────┴──────────┴──────────┘
+```
+
+**Modal/Dialog:**
+```
+        ┌─────────────────────┐
+        │ [X] Modal Title     │
+        ├─────────────────────┤
+        │                     │
+        │ Modal Content        │
+        │                     │
+        │ [Cancel] [OK]       │
+        └─────────────────────┘
+```
+
+---
+
+## 4. Screen Index
+
+| Screen | Section (Detail Screen) | User Role | Purpose |
+|--------|-------------------------|-----------|---------|
+| <Screen 1> | 5 | <Role> | <Purpose> |
+| <Screen 2> | 6 | <Role> | <Purpose> |
+| <Screen 3> | 7 | <Role> | <Purpose> |
+
+> Each screen has a corresponding section in the Detail Screen document with wireframe, layout, and interactions.
+
+---
+
+## 5. Responsive Design Considerations
+
+**Breakpoints:**
+- Mobile: <Width>
+- Tablet: <Width>
+- Desktop: <Width>
+
+**Mobile Adaptations:**
+- <Adaptation 1>
+- <Adaptation 2>
+
+**Tablet Adaptations:**
+- <Adaptation 1>
+- <Adaptation 2>
+
+---
+
+## 6. Common UI Patterns
+
+**Buttons:**
+- Primary: <Style>
+- Secondary: <Style>
+- Danger: <Style>
+
+**Forms:**
+- Input fields: <Style>
+- Validation messages: <Style>
+- Submit buttons: <Style>
+
+**Tables/Lists:**
+- Row style: <Style>
+- Hover state: <Style>
+- Selection: <Style>
+
+**Modals/Dialogs:**
+- Size: <Dimensions>
+- Overlay: <Style>
+- Close button: <Position>
+
+---
+
+## 7. Accessibility Considerations
+
+**Keyboard Navigation:**
+- <Requirement 1>
+- <Requirement 2>
+
+**Screen Reader Support:**
+- <Requirement 1>
+- <Requirement 2>
+
+**Color Contrast:**
+- <Requirement>
+
+---
+
+## 8. Visual Resources
+
+**Design Tools:**
+> Reference tools used (Figma, Axure, Uizard, etc.)
+
+**Wireframe Files:**
+- Low-fidelity: `<path/to/wireframe.png>` or `<Figma Link>`
+- High-fidelity: `<path/to/mockup.png>` or `<Figma Link>`
+
+**Prototype Links:**
+> Add links to interactive prototypes when available.
+- Interactive prototype: `<Figma/InVision/Other Link>`
+
+**Image Placeholders:**
+> For markdown documents, you can reference images:
+```markdown
+![Screen Name Wireframe](screens/screen-name-wireframe.png)
+![Screen Name Mockup](screens/screen-name-mockup.png)
+```
+
+---
+
+## 9. Notes
+
+**Visual Guidelines:**
+> Tips for creating better visual mockups:
+- Use consistent spacing (8px grid system)
+- Show actual content examples, not just "Lorem ipsum"
+- Include error states and empty states
+- Show hover/active states for interactive elements
+
+**Future Enhancements:**
+- <Enhancement 1>
+- <Enhancement 2>