ai-spector 0.1.1

package/assets/workflow/templates/detail_design/feature-list-template.md

@@ -0,0 +1,39 @@
+# Detail Design: Feature List
+
+> This document lists all features that have (or will have) a detail design. Each feature links to its **detail design document**, where component design, sequence diagrams, API specs, database schema, UI design, and implementation details are specified.
+>
+> **Structure:** (1) This file — index of all features with links; (2) **One file per feature** (e.g. in `features/` or alongside this file), each created from the [Feature Detail Design Template](feature-detail-design-template.md).
+
+**Related Documents:**
+- [Architecture Overview](common/architecture-overview-template.md)
+- [Security Patterns](common/security-patterns-template.md)
+- [Error Handling Patterns](common/error-handling-patterns-template.md)
+- [Performance Standards](common/performance-standards-template.md)
+- [Integration Patterns](common/integration-patterns-template.md)
+- [Deployment & Infrastructure](common/deployment-infrastructure-template.md)
+- [Feature Detail Design Template](feature-detail-design-template.md) — template for each feature’s detail doc
+- [Basic Design - API Design](../../basic_design/api-design-template.md)
+- [Basic Design - Database Design](../../basic_design/db-design-template.md)
+- [Basic Design - Mockup Screens](../../basic_design/mockup-screens-template.md)
+
+---
+
+## 1. List of Features
+
+| Feature ID | Feature Name | SRS Reference | Priority | Status |
+|------------|--------------|----------------|----------|--------|
+| F-01 | <Feature Name> | SRS Section 4.1 | High/Medium/Low | Draft/Approved |
+| F-02 | <Feature Name> | SRS Section 4.2 | High/Medium/Low | Draft/Approved |
+
+**Conventions:**
+- **Feature ID:** Matches SRS system feature ID (e.g. F-01, F-02) or your project’s ID scheme.
+
+---
+
+## 2. Feature Dependencies (Optional)
+
+> Document which features depend on others for implementation or integration.
+
+| Feature | Depends On | Description |
+|---------|------------|-------------|
+| F-02 | F-01 | <e.g. F-02 uses APIs/data from F-01> |

package/assets/workflow/templates/srs/1-introduction.md

@@ -0,0 +1,58 @@
+## 1. Introduction
+
+> The introduction presents an overview to help the reader understand how the SRS is organized and how to use it.
+
+### 1.1 Document Purpose
+
+> Identify the product whose software requirements are specified in this document, including the revision or release number. Describe the different types of reader that the document is intended for.
+
+**Product Name:** 
+
+**Document Version:** 
+
+**Intended Audience:**
+
+- Developers
+- Project Managers
+- Business Analysts
+- Testers
+- 
+
+### 1.2 Document Conventions
+
+> Describe any standards or typographical conventions used, including the meaning of specific text styles, highlighting, or notations. Specify the format for requirement identifiers.
+
+**Requirement ID Format:** <Format, e.g., FR-XX-YY>
+
+**Notation Conventions:**
+
+- **Bold text:** 
+- `Code/Technical terms:` 
+
+### 1.3 Project Scope
+
+> Provide a short description of the software being specified and its purpose. Relate the software to user or corporate goals and to business objectives and strategies.
+
+**Software Purpose:**
+
+> Describe the purpose of the software being specified.
+
+**Major Features:**
+
+- <Feature 1>
+- <Feature 2>
+- <Feature 3>
+
+**Out of Scope:**
+
+- <Out of scope item 1>
+- <Out of scope item 2>
+
+### 1.4 References
+
+> List any documents or other resources to which this SRS refers. Include hyperlinks if available.
+
+
+| Reference ID | Title | Version | Date | Source/URL |
+| ------------ | ----- | ------- | ---- | ---------- |
+| REF-01       |       |         |      |            |

package/assets/workflow/templates/srs/2-overall-description.md

@@ -0,0 +1,91 @@
+## 2. Overall Description
+
+> This section presents a high-level overview of the product and the environment in which it will be used, the anticipated users, and known constraints, assumptions, and dependencies.
+
+### 2.1 Product Perspective
+
+> Describe the product's context and origin. If this SRS defines a component of a larger system, state how this software relates to the overall system and identify major interfaces.
+
+**Product Context:**
+
+> Describe whether this is a new product, replacement, upgrade, or component of a larger system.
+
+**System Relationships:**
+
+> If part of a larger system, describe relationships and interfaces.
+
+**Context Diagram:**
+
+> Optionally include a context diagram.
+
+```mermaid
+graph TB
+    subgraph "External Systems"
+        ES1[External System 1]
+    end
+    subgraph "Your System"
+        YourSystem[Your Product]
+    end
+    ES1 --> YourSystem
+```
+
+
+
+### 2.2 User Classes and Characteristics
+
+> Identify the various user classes that you anticipate will use this product and describe their pertinent characteristics.
+
+
+| User Class     | Description | Characteristics | Priority          |
+| -------------- | ----------- | --------------- | ----------------- |
+| <User Class 1> |             |                 | Primary/Secondary |
+
+
+### 2.3 Operating Environment
+
+> Describe the environment in which the software will operate.
+
+**Hardware Platform:**
+
+- <Hardware requirement 1>
+- <Hardware requirement 2>
+
+**Operating Systems:**
+
+- <OS 1> 
+- <OS 2>
+
+**Software Components:**
+
+- <Software component 1>
+- <Software component 2>
+
+### 2.4 Design and Implementation Constraints
+
+> Describe any factors that will limit the options available to the developers.
+
+**Technology Constraints:**
+
+- **Programming Languages:** 
+- **Databases:** 
+- **Frameworks:**
+
+**Corporate/Regulatory Policies:**
+
+- <Policy 1>
+- <Policy 2>
+
+### 2.5 Assumptions and Dependencies
+
+> List any assumed factors that could affect the requirements stated in the SRS. Identify any dependencies the project has on external factors.
+
+**Assumptions:**
+
+- <Assumption 1>
+- <Assumption 2>
+
+**Dependencies:**
+
+- <Dependency 1>
+- <Dependency 2>
+

package/assets/workflow/templates/srs/3-use-case-detail-template.md

@@ -0,0 +1,142 @@
+## Use Case:
+
+**Use Case ID:** UC-XX  
+**Version:** 1.0  
+**Status:** Draft / In Review / Approved
+
+---
+
+### 1. Use Case Overview
+
+**Use Case Name:** 
+
+**Brief Description:**
+
+> Provide a concise one or two sentence description of what this use case accomplishes.
+
+**Actor(s):**
+
+- **Primary Actor:** 
+- **Secondary Actor(s):** <Other actors involved, if any>
+
+**Priority:** High / Medium / Low
+
+**Preconditions:**
+
+- Precondition 1
+- Precondition 2
+
+**Postconditions:**
+
+- Postcondition 1
+- Postcondition 2
+
+**Trigger:**
+
+> Describe the event that initiates this use case.
+
+---
+
+### 2. Main Success Scenario (Basic Flow)
+
+> Describe the primary path through the use case when everything goes as expected.
+
+---
+
+### 3. Alternative Flows
+
+#### 3.1 Alternative Flow A:
+
+**Condition:** 
+
+**Steps:**
+
+---
+
+### 4. Exception Flows (Error Handling)
+
+#### 4.1 Exception A:
+
+**Condition:** 
+
+**Steps:**
+
+---
+
+### 5. Business Rules
+
+
+| Rule ID  | Description |
+| -------- | ----------- |
+| BR-XX-01 |             |
+
+
+---
+
+### 6. Functional Requirements
+
+
+| Req ID   | Requirement Description |
+| -------- | ----------------------- |
+| FR-XX-01 |                         |
+
+
+---
+
+### 7. Data Requirements
+
+**Input Data:**
+
+
+| Data Element | Type | Required | Validation Rules |
+| ------------ | ---- | -------- | ---------------- |
+|              |      | Yes/No   |                  |
+
+
+**Output Data:**
+
+
+| Data Element | Type | Description |
+| ------------ | ---- | ----------- |
+|              |      |             |
+
+
+---
+
+### 8. User Interface Requirements
+
+**Screen/Page:** 
+
+**Key UI Elements:**
+
+- <UI element 1>
+- <UI element 2>
+
+**UI Reference:** 
+
+---
+
+### 9. Related Use Cases
+
+
+| Use Case ID | Relationship | Description |
+| ----------- | ------------ | ----------- |
+| UC-YY       | includes     |             |
+
+
+---
+
+### 10. Notes
+
+**Sequence Diagram (Optional):**
+
+```mermaid
+sequenceDiagram
+    participant Actor as <Actor Name>
+    participant System as <System Name>
+    Actor->>System: <Action>
+    System-->>Actor: <Response>
+```
+
+
+

package/assets/workflow/templates/srs/3-use-cases.md

@@ -0,0 +1,53 @@
+## 3. Use Cases
+
+> This section documents how users interact with the system to achieve specific goals. Use cases provide detailed interaction flows that guide implementation and testing, bridging high-level user needs and detailed system requirements.
+>
+> **Structure:** Split into **two parts**: (1) this index file — diagrams and list with links; (2) **one file per use case** in `03-use-cases/` (e.g. `03-use-cases/uc-01-<name>.md`). Generate each use case detail from the **use-case-detail template** (`3-use-case-detail-template.md`).
+
+### 3.1 Use Case Diagrams
+
+> Provide visual representations of actors, use cases, and their relationships using UML use case diagrams. Use Mermaid diagrams or equivalent notation. Include system boundary, actors (stick figures or actor notation), use cases (ovals), and relationships (associations, includes, extends).
+
+**System Context Diagram:**
+
+> Provide visual representations of actors, use cases, and their relationships using UML use case diagrams. Use Mermaid diagrams or equivalent notation.
+
+```mermaid
+graph TB
+    subgraph "Your System Name"
+        UC1[Use Case 1]
+        UC2[Use Case 2]
+    end
+    Actor1((Actor 1))
+    Actor2((Actor 2))
+    Actor1 --> UC1
+    Actor2 --> UC2
+    UC2 -.includes.-> UC1
+```
+
+
+
+---
+
+### 3.2 List Use Case
+
+> Provide a comprehensive list of all use cases in the system.
+
+
+| Use Case ID | Use Case Name | Actor(s) | Priority        | Status         |
+| ----------- | ------------- | -------- | --------------- | -------------- |
+| UC-01       |               |          | High/Medium/Low | Draft/Approved |
+| UC-02       |               |          | High/Medium/Low | Draft/Approved |
+| UC-03       |               |          | High/Medium/Low | Draft/Approved |
+
+
+**Use Case Relationships:**
+
+> Document relationships between use cases (includes, extends, generalizes).
+
+
+| Use Case | Relationship Type | Related Use Case | Description |
+| -------- | ----------------- | ---------------- | ----------- |
+| UC-02    | includes          | UC-01            |             |
+
+

package/assets/workflow/templates/srs/4-system-feature-detail-template.md

@@ -0,0 +1,131 @@
+## Feature:
+
+**Feature ID:** F-XX  
+**Version:** 1.0  
+**Status:** Draft / In Review / Approved
+
+> Replace "F-XX" with the actual feature ID and "<System Feature Name>" in section 1 with the actual feature name.
+
+---
+
+### 1. Description
+
+> Provide a short description of the feature and indicate whether it is of High, Medium, or Low priority.
+
+**Feature Name:** <System Feature Name>
+
+**Priority:** High / Medium / Low
+
+**Brief Description:**
+> Provide a concise description of what this feature does and why it's needed.
+
+**User Story (Optional - Agile format):**
+> Use this format for Agile projects or when you want to express requirements from a user perspective.
+
+**As a** <user role>, **I want to** <action/functionality> **so that** <benefit/value>.
+
+*Example: As a Sales Representative, I want to create a new order so that I can record transactions with customers.*
+
+**Feature Scope:**
+**In Scope:**
+- <Scope item 1>
+- <Scope item 2>
+
+**Out of Scope:**
+- <Out of scope item 1>
+
+**Related Use Cases:**
+- UC-XX: <Use Case Name>
+- UC-YY: <Use Case Name>
+
+---
+
+### 2. Stimulus/Response Sequences
+
+> List the sequences of user actions and system responses that stimulate the behavior defined for this feature.
+
+**Sequence 1: <Primary User Action>**
+
+| Step | Actor/Action | System Response |
+|------|--------------|-----------------|
+| 1 | <Actor> <action> | <System> <response> |
+| 2 | <Actor> <action> | <System> <response> |
+| 3 | <System> <response> | <Use case ends> |
+
+**Error Handling:**
+
+| Step | Actor/Action | System Response | Error Condition |
+|------|--------------|-----------------|------------------|
+| 1 | <Actor> <action> | <System> <response> | <Error condition> |
+| 2 | <System> <detects error> | <System> <error handling> | |
+
+---
+
+### 3. Functional Requirements
+
+> Itemize the specific functional requirements associated with this feature. Use "TBD" as a placeholder when necessary information is not yet available.
+
+| Req ID | Requirement Description | Priority | Status |
+|--------|------------------------|----------|--------|
+| FR-XX-01 | <Functional requirement description> | High/Medium/Low | Draft/Approved |
+| FR-XX-02 | <Functional requirement description> | High/Medium/Low | Draft/Approved |
+
+**FR-XX-01: <Requirement Name>**
+
+**User Story (if applicable):**
+> *As a <user role>, I want to <action> so that <benefit>.*
+
+**Description:**
+> Elaborate on what the system must do.
+
+**Acceptance Criteria:**
+- <Criterion 1>
+- <Criterion 2>
+
+**Error Handling:**
+- <Error condition 1>: <Handling approach>
+- <Error condition 2>: <Handling approach>
+
+---
+
+**Data Requirements:**
+
+**Input Data:**
+| Data Element | Type | Required | Validation Rules |
+|--------------|------|----------|------------------|
+| <Field Name> | <Type> | Yes/No | <Validation rules> |
+
+**Output Data:**
+| Data Element | Type | Description |
+|--------------|------|-------------|
+| <Field Name> | <Type> | <Description> |
+
+---
+
+**User Interface Requirements:**
+
+**Screens/Pages:**
+- <Screen 1>: <Description>
+- <Screen 2>: <Description>
+
+**Key UI Elements:**
+- <UI element 1>
+- <UI element 2>
+
+**UI Reference:** <Link to wireframe or mockup>
+
+---
+
+**Dependencies:**
+
+**Internal Dependencies:**
+- <Other feature / component>: <Dependency description>
+
+**External Dependencies:**
+- <External system/component>: <Dependency description>
+
+---
+
+**Assumptions:**
+- <Assumption 1>
+- <Assumption 2>

package/assets/workflow/templates/srs/4-system-features-list-template.md

@@ -0,0 +1,39 @@
+## 4. System Features
+
+> This section catalogs **what the system delivers** as discrete features: names, ownership by role, priority, status, and links to deeper specs. Use **Section 3** for interaction flows (use cases); use this section for a **feature-level** view of the product or subsystem.
+>
+> **Structure:** (1) this index — optional diagram(s) and the register table; (2) **one file per feature** in `04-system-features/` (for example `04-system-features/f-01-<name>.md`). Generate each detail from **`4-system-feature-detail-template.md`**. Keep **System Feature ID** values stable and consistent with the detail doc.
+
+### 4.1 Feature Diagram (Optional)
+
+> Use Mermaid when a picture helps: group features by area, show **depends on** / **enables**, or map actors to features. Replace the placeholder below or add more diagrams like in Section 3.
+
+```mermaid
+graph TB
+    subgraph "Your System Name"
+        F01[F-01 Feature 1]
+        F02[F-02 Feature 2]
+    end
+    F01 --> F02
+```
+
+---
+
+### 4.2 List of System Features
+
+> Provide a complete register: one row per feature ID. Use **Summary** for a single scannable sentence; put requirements, acceptance criteria, and edge cases in the linked detail file.
+
+*Optional: one line of context (e.g. how this list maps to modules, epics, or releases).*
+
+| System Feature ID | System Feature Name | Summary | Related use case IDs | Actor(s) | Priority        | Status         | Link to Detail |
+| ----------------- | ------------------- | ------- | -------------------- | -------- | --------------- | -------------- | -------------- |
+| F-01              |                     |         | UC-01, UC-02         |          | High/Medium/Low | Draft/Approved | [F-01 Detail](04-system-features/f-01-<slug>.md) |
+| F-02              |                     |         |                      |          | High/Medium/Low | Draft/Approved | [F-02 Detail](04-system-features/f-02-<slug>.md) |
+
+### 4.3 Feature Relationships (Optional)
+
+> Document **depends on**, **includes**, **extends**, or other relationships between features so the register stays easy to read.
+
+| Feature | Relationship Type | Related Feature | Description |
+| ------- | ----------------- | --------------- | ----------- |
+| F-02    | depends on        | F-01            |             |

package/assets/workflow/templates/srs/5-data-requirements.md

@@ -0,0 +1,59 @@
+## 5. Data Requirements
+
+> This section describes various aspects of the data that the system will consume as inputs, process in some fashion, or create as outputs.
+
+### 5.1 Logical Data Model
+
+> A data model is a visual representation of the data objects and collections the system will process and the relationships between them.
+
+**Entity-Relationship Diagram:**
+> Include an ER diagram or data model here.
+
+```mermaid
+erDiagram
+    ENTITY1 ||--o{ ENTITY2 : "relationship"
+    ENTITY1 {
+        string field1
+        int field2
+    }
+```
+
+**Data Objects:**
+| Data Object | Description | Key Attributes |
+|-------------|-------------|----------------|
+| <Object 1> | <Description> | <Attributes> |
+
+### 5.2 Data Dictionary
+
+> The data dictionary defines the composition of data structures and the meaning, data type, length, format, and allowed values for the data elements.
+
+**Note:** If the data dictionary is extensive, consider storing it as a separate document and referencing it here.
+
+| Element Name | Data Type | Length | Format | Allowed Values | Description |
+|--------------|-----------|--------|--------|----------------|-------------|
+| <Element 1> | <Type> | <Length> | <Format> | <Values> | <Description> |
+
+### 5.3 Reports
+
+> If your application will generate any reports, identify them here and describe their characteristics.
+
+| Report ID | Report Name | Description | Frequency | Audience |
+|-----------|-------------|-------------|-----------|----------|
+| RPT-01 | <Report Name> | <Description> | <Frequency> | <Audience> |
+
+### 5.4 Data Acquisition, Integrity, Retention, and Disposal
+
+> Describe how data is acquired and maintained. State requirements regarding data integrity, retention, and disposal.
+
+**Data Integrity:**
+- **Validation:** <Validation requirements>
+- **Backups:** <Backup requirements>
+
+**Data Retention:**
+- <Retention policy 1>
+- <Retention policy 2>
+
+**Data Disposal:**
+- <Disposal policy 1>
+- <Disposal policy 2>
+

package/assets/workflow/templates/srs/6-external-interfaces.md

@@ -0,0 +1,56 @@
+## 6. External Interface Requirements
+
+> This section provides information to ensure that the system will communicate properly with users and with external hardware or software elements.
+
+### 6.1 User Interfaces
+
+> Describe the logical characteristics of each interface between the software product and the users.
+
+**UI Standards:**
+- <UI standard 1>
+- <UI standard 2>
+
+**Standard UI Elements:**
+- <UI element 1>
+- <UI element 2>
+
+**Error Message Standards:**
+- <Standard 1>
+- <Standard 2>
+
+**UI Specification Reference:**
+> Reference separate UI specification document if available.
+- <UI specification document>
+
+### 6.2 Software Interfaces
+
+> Describe the connections between this product and other software components.
+
+| Component Name | Version | Purpose | Interface Type |
+|----------------|---------|---------|---------------|
+| <Component 1> | <Version> | <Purpose> | <Type> |
+
+**Interface Details:**
+- **Protocol:** <Protocol>
+- **Data Format:** <Data format>
+- **Service Level:** <Response time, frequency>
+- **Security:** <Security requirements>
+
+### 6.3 Hardware Interfaces
+
+> Describe the characteristics of each interface between the software and hardware (if any) components of the system.
+
+| Hardware Component | Description | Interface Type | Protocol |
+|-------------------|-------------|----------------|----------|
+| <Component 1> | <Description> | <Type> | <Protocol> |
+
+### 6.4 Communications Interfaces
+
+> State the requirements for any communication functions the product will use.
+
+**Communication Functions:**
+- **Email:** <Requirements>
+- **Web Browser:** <Supported browsers>
+- **Network Protocols:** <Protocols>
+- **Security:** <Security requirements>
+