@dtt_siye/atool 1.1.0

package/skills/requirements-writer/templates/module-prd-template.md

@@ -0,0 +1,362 @@
+---
+doc_id: PRD-<MODULE>-31XX
+title: PRD - <Module Name>
+status: draft
+owner: PM
+last_updated: YYYY-MM-DD
+related_docs:
+  - docs/300-requirements/30x-prd-outline.md
+  - docs/200-product/201-project-brief.md
+  - docs/100-standards/102-requirements-standards.md
+---
+
+## Purpose
+
+This document defines the product requirements for the **<Module Name>** module of the <Project Name> system. It specifies what the module must do from a business and user perspective, leaving technical implementation details to architecture and design documents.
+
+## Problem & Goals
+
+### Problem
+<What specific business problem does this module solve? What pain points does it address?>
+
+### Goals
+<What are the primary objectives for this module?>
+<What does success look like?>
+
+### Success Metrics
+<How will we measure success? Include quantifiable metrics>
+- Example: "Reduce comparison time by 50%"
+- Example: "Achieve 95% accuracy in <function>"
+- Example: "Support <N> concurrent users"
+
+## Scope
+
+### In Scope
+<For this specific module, what IS included?>
+
+- **<Feature Area 1>**
+  - <Detail specific capabilities>
+  - <Define boundaries>
+
+- **<Feature Area 2>**
+  - <Detail specific capabilities>
+  - <Define boundaries>
+
+- **<Feature Area 3>**
+  - <Detail specific capabilities>
+  - <Define boundaries>
+
+### Out of Scope
+<For this specific module, what is NOT included?>
+
+- <Capability 1>: <Reason it's out of scope>
+- <Capability 2>: <Reason it's out of scope>
+- <Capability 3>: <Will be handled by module X>
+
+### Dependencies on Other Modules
+<Which other modules does this module depend on?>
+
+- **<Module A>**: <Dependency description>
+- **<Module B>**: <Dependency description>
+
+### Dependent Modules
+<Which other modules depend on this module?>
+
+- **<Module X>**: <How they use this module>
+- **<Module Y>**: <How they use this module>
+
+## Personas & Scenarios
+
+### Primary Persona(s)
+<Which personas from the requirements outline primarily interact with this module?>
+
+#### <Persona Name>
+- **Role**: <Job title>
+- **Goals**: <What they want to achieve with this module>
+- **Skill Level**: <Technical proficiency>
+- **Typical Environment**: <Where/how they work>
+
+#### Key Scenarios
+
+**Scenario 1: <Scenario Title>**
+- **Context**: <Situation description>
+- **Actions**: <Step-by-step user actions>
+- **Expected Outcome**: <What should happen>
+- **Edge Cases**: <What could go wrong>
+
+**Scenario 2: <Scenario Title>**
+- **Context**: <Situation description>
+- **Actions**: <Step-by-step user actions>
+- **Expected Outcome**: <What should happen>
+- **Edge Cases**: <What could go wrong>
+
+### Secondary Persona(s)
+<Which secondary personas interact with this module?>
+
+#### <Persona Name>
+- **Role**: <Job title>
+- **Goals**: <What they want to achieve>
+- **Interaction Model**: <How they interact>
+
+## Functional Requirements
+
+Each functional requirement must specify:
+- **Input**: What data/information is needed
+- **Processing**: What logic/rules are applied
+- **Output**: What is produced/returned
+- **Exceptions**: How errors/edge cases are handled
+- **Verification**: How to verify it works
+
+### FR-<MODULE>-001: <Requirement Title>
+
+**Description**: <Clear description of what the system must do>
+
+**Input**:
+- <Input 1>: <Description, data type, validation rules>
+- <Input 2>: <Description, data type, validation rules>
+
+**Processing**:
+- <Step 1>: <Description of processing rule>
+- <Step 2>: <Description of processing rule>
+
+**Output**:
+- <Output 1>: <Description, format, structure>
+- <Output 2>: <Description, format, structure>
+
+**Exceptions**:
+- <Exception 1>: <Condition> → <Handling>
+- <Exception 2>: <Condition> → <Handling>
+
+**Verification**:
+- <How to verify this requirement is met>
+
+**Linked User Stories**:
+- `docs/300-requirements/330-user-stories/33x-us-<module>-<feature>.md`
+
+### FR-<MODULE>-002: <Requirement Title>
+
+**Description**: <Clear description of what the system must do>
+
+**Input**:
+- <Input 1>: <Description, data type, validation rules>
+- <Input 2>: <Description, data type, validation rules>
+
+**Processing**:
+- <Step 1>: <Description of processing rule>
+- <Step 2>: <Description of processing rule>
+
+**Output**:
+- <Output 1>: <Description, format, structure>
+- <Output 2>: <Description, format, structure>
+
+**Exceptions**:
+- <Exception 1>: <Condition> → <Handling>
+- <Exception 2>: <Condition> → <Handling>
+
+**Verification**:
+- <How to verify this requirement is met>
+
+**Linked User Stories**:
+- `docs/300-requirements/330-user-stories/33x-us-<module>-<feature>.md`
+
+<Continue for all functional requirements...>
+
+## Non-Functional Requirements
+
+All NFRs must be **quantifiable and testable**.
+
+### NFR-<MODULE>-001: Performance
+
+**Requirement**: <Specific performance requirement>
+- **Metric**: <Quantifiable measure, e.g., "Response time < 2s for 95% of requests">
+- **Condition**: <Under what conditions>
+- **Measurement**: <How to measure>
+- **Verification**: <Test method>
+
+### NFR-<MODULE>-002: Scalability
+
+**Requirement**: <Specific scalability requirement>
+- **Metric**: <Quantifiable measure, e.g., "Support 1000 concurrent users">
+- **Condition**: <Under what conditions>
+- **Measurement**: <How to measure>
+- **Verification**: <Test method>
+
+### NFR-<MODULE>-003: Availability
+
+**Requirement**: <Specific availability requirement>
+- **Metric**: <Quantifiable measure, e.g., "99.9% uptime during business hours">
+- **Condition**: <Under what conditions>
+- **Measurement**: <How to measure>
+- **Verification**: <Test method>
+
+### NFR-<MODULE>-004: Security
+
+**Requirement**: <Specific security requirement>
+- **Metric**: <Quantifiable measure, e.g., "All API calls authenticated via OAuth2">
+- **Condition**: <Under what conditions>
+- **Measurement**: <How to measure>
+- **Verification**: <Test method>
+- **Reference**: `docs/600-architecture/6xx-security-view.md`
+
+### NFR-<MODULE>-005: Audit
+
+**Requirement**: <Specific audit requirement>
+- **Metric**: <Quantifiable measure, e.g., "All data exports logged with user, timestamp, scope">
+- **Condition**: <Under what conditions>
+- **Measurement**: <How to measure>
+- **Verification**: <Test method>
+- **Reference**: `docs/600-architecture/6xx-security-view.md`
+
+### NFR-<MODULE>-006: Data Quality
+
+**Requirement**: <Specific data quality requirement>
+- **Metric**: <Quantifiable measure, e.g., "Data accuracy > 99%">
+- **Condition**: <Under what conditions>
+- **Measurement**: <How to measure>
+- **Verification**: <Test method>
+- **Reference**: `docs/500-data/502-data-dictionary.md`
+
+### NFR-<MODULE>-007: Compatibility
+
+**Requirement**: <Specific compatibility requirement>
+- **Metric**: <Quantifiable measure, e.g., "Support Chrome 90+, Safari 14+">
+- **Condition**: <Under what conditions>
+- **Measurement**: <How to measure>
+- **Verification**: <Test method>
+
+## UX Notes
+
+**Important**: This section describes **interaction intent only**. Detailed UI/UX design belongs in design documents.
+
+### User Flows
+
+**Flow 1: <Flow Name>**
+- **Starting Point**: <Where user starts>
+- **Steps**: <High-level interaction steps>
+- **Decision Points**: <Where user makes choices>
+- **End State**: <Successful completion state>
+
+**Flow 2: <Flow Name>**
+- **Starting Point**: <Where user starts>
+- **Steps**: <High-level interaction steps>
+- **Decision Points**: <Where user makes choices>
+- **End State**: <Successful completion state>
+
+### Interaction Patterns
+
+- **<Pattern 1>**: <Description of interaction approach>
+- **<Pattern 2>**: <Description of interaction approach>
+
+### Feedback & Communication
+
+- **Success Feedback**: <What user sees on success>
+- **Error Feedback**: <What user sees on error>
+- **Progress Indication**: <How progress is shown>
+- **Loading States**: <How loading/waiting is communicated>
+
+### Accessibility
+
+- **Keyboard Navigation**: <Requirements>
+- **Screen Reader Support**: <Requirements>
+- **Color Contrast**: <Requirements>
+- **Font Sizing**: <Requirements>
+
+**Design Reference**: `docs/400-design/4xx-ux-design.md`
+
+## Data Requirements
+
+### Data Entities
+
+<List key data entities this module uses/produces>
+
+- **<Entity 1>**: <Description>
+  - **Reference**: `docs/500-data/502-data-dictionary.md`
+  - **Operations**: <Read/Write/Update/Delete>
+
+- **<Entity 2>**: <Description>
+  - **Reference**: `docs/500-data/502-data-dictionary.md`
+  - **Operations**: <Read/Write/Update/Delete>
+
+### Data Validations
+
+<List critical data validations>
+
+- **<Validation 1>**: <Field> must <rule>
+- **<Validation 2>**: <Field> must <rule>
+
+### Data Retention
+
+- **Retention Policy**: <How long data is kept>
+- **Archive Policy**: <How/archived/deleted>
+
+## Acceptance Criteria
+
+### Module-Level Acceptance Criteria
+
+<These are high-level criteria for the entire module>
+
+- [ ] <AC-<MODULE>-001>: <Objectively verifiable criterion>
+- [ ] <AC-<MODULE>-002>: <Objectively verifiable criterion>
+- [ ] <AC-<MODULE>-003>: <Objectively verifiable criterion>
+
+### Per-Feature Acceptance Criteria
+
+<Reference specific User Story acceptance criteria>
+
+See individual User Stories in:
+- `docs/300-requirements/330-user-stories/33x-us-<module>-<feature>.md`
+
+**Important**: All acceptance criteria must be objectively verifiable. Avoid subjective language like:
+- ❌ "Good user experience"
+- ❌ "Fast response"
+- ❌ "Easy to use"
+
+Instead use:
+- ✅ "User can complete task in < 3 minutes"
+- ✅ "95% of API calls complete in < 2 seconds"
+- ✅ "90% of first-time users complete task without assistance"
+
+## Risks & Assumptions
+
+### Assumptions
+- **Assumption 1**: <Description> | <Impact if wrong>
+- **Assumption 2**: <Description> | <Impact if wrong>
+
+### Risks
+- **Risk 1**: <Description> | <Probability> | <Impact> | <Mitigation>
+- **Risk 2**: <Description> | <Probability> | <Impact> | <Mitigation>
+
+### Dependencies
+- **Dependency 1**: <External system/service> | <Risk level>
+- **Dependency 2**: <Another module's completion> | <Risk level>
+
+## Open Questions
+
+<List questions that need answers before implementation>
+
+- **Question 1**: <What we need to decide> | <Stakeholder> | <Due date>
+- **Question 2**: <What we need to decide> | <Stakeholder> | <Due date>
+
+## References
+
+### Product Documents
+- Project Brief: `docs/200-product/201-project-brief.md`
+- Requirements Outline: `docs/300-requirements/30x-prd-outline.md`
+
+### Design Documents
+- UX Design: `docs/400-design/4xx-ux-design.md`
+- Functional Spec: `docs/400-design/4xx-functional-spec.md`
+
+### Data Documents
+- Data Dictionary: `docs/500-data/502-data-dictionary.md`
+- ERD: `docs/500-data/501-entity-relationship.md`
+
+### Architecture Documents
+- Security View: `docs/600-architecture/6xx-security-view.md`
+- API Specification: `docs/700-engineering/701-api-reference.md`
+
+## Version History
+
+| Version | Date | Owner | Change |
+|---|---|---|---|
+| v0.1 | YYYY-MM-DD | PM | Initial module PRD |

package/skills/requirements-writer/templates/prd-outline-template.md

@@ -0,0 +1,185 @@
+---
+doc_id: PRD-OUTLINE-X
+title: Requirements Outline - <Project Name>
+status: draft
+owner: PM
+last_updated: YYYY-MM-DD
+related_docs:
+  - docs/x00-xxx/xxx.md
+---
+
+## Purpose
+
+This document provides the high-level outline and writing plan for the <Project Name> Product Requirements Document (PRD). It defines the module breakdown, dependencies, and sequencing to ensure comprehensive requirements coverage while avoiding context length limitations.
+
+## Project Overview
+
+### Problem Statement
+<Describe the business problem this project aims to solve. What pain points exist? Why is this needed now?>
+
+### Project Goals
+<What are the primary objectives? What does success look like?>
+
+### High-Level Scope
+
+#### In Scope
+- <List the main areas/modules that ARE in scope>
+- <Keep this focused on what will be delivered>
+- <Think in terms of functional modules>
+
+#### Out of Scope
+- <Explicitly list what is NOT in scope>
+- <Future phases>
+- <Related but separate initiatives>
+
+## Module Breakdown
+
+### Identified Modules
+
+<Identify all major functional modules. For Inspection Agent example:>
+
+1. **<MODULE_A>** (e.g., COMPARE)
+   - Purpose: <Brief description>
+   - Key Features: <List key features>
+
+2. **<MODULE_B>** (e.g., JURY)
+   - Purpose: <Brief description>
+   - Key Features: <List key features>
+
+3. **<MODULE_C>** (e.g., PORTAL)
+   - Purpose: <Brief description>
+   - Key Features: <List key features>
+
+4. **<MODULE_D>** (e.g., DETECTORS)
+   - Purpose: <Brief description>
+   - Key Features: <List key features>
+
+5. **<MODULE_E>** (e.g., AUTO_FIX)
+   - Purpose: <Brief description>
+   - Key Features: <List key features>
+
+### Module Dependency Graph
+
+```
+<Describe dependencies between modules. Example:>
+
+PORTAL (UI Layer)
+├── COMPARE (Core Service)
+│   └── DETECTORS (Analysis Engine)
+├── JURY (Evaluation Service)
+│   └── COMPARE (depends on comparison results)
+└── AUTO_FIX (Remediation Service)
+    ├── COMPARE (needs analysis)
+    └── JURY (needs evaluation)
+
+Writing Order:
+1. DETECTORS (no dependencies)
+2. COMPARE (depends on DETECTORS)
+3. JURY (depends on COMPARE)
+4. AUTO_FIX (depends on COMPARE, JURY)
+5. PORTAL (depends on all services)
+```
+
+## User Personas
+
+### Primary Personas
+
+1. **<Persona 1 Name>**
+   - Role: <Job role>
+   - Goals: <What they want to achieve>
+   - Pain Points: <Current challenges>
+   - Typical Scenarios: <Common use cases>
+
+2. **<Persona 2 Name>**
+   - Role: <Job role>
+   - Goals: <What they want to achieve>
+   - Pain Points: <Current challenges>
+   - Typical Scenarios: <Common use cases>
+
+### Secondary Personas
+
+<List any secondary stakeholders, admin users, etc.>
+
+## Writing Plan
+
+### Phase 1: Requirements Outline (Current Document)
+- [x] Define project scope
+- [x] Identify modules
+- [x] Map dependencies
+- [x] Define writing sequence
+
+### Phase 2: Module-Level PRDs
+
+<Order modules by dependency (start with modules that have no dependencies)>
+
+1. **<MODULE_FIRST>** (`docs/300-requirements/31x-prd-<module-first>.md`)
+   - Status: [ ] Not Started | [ ] In Progress | [ ] Complete
+   - Estimated User Stories: <number>
+   - Notes: <Any special considerations>
+
+2. **<MODULE_SECOND>** (`docs/300-requirements/31x-prd-<module-second>.md`)
+   - Status: [ ] Not Started | [ ] In Progress | [ ] Complete
+   - Depends on: <MODULE_FIRST>
+   - Estimated User Stories: <number>
+   - Notes: <Any special considerations>
+
+3. **<MODULE_THIRD>** (`docs/300-requirements/31x-prd-<module-third>.md`)
+   - Status: [ ] Not Started | [ ] In Progress | [ ] Complete
+   - Depends on: <modules>
+   - Estimated User Stories: <number>
+   - Notes: <Any special considerations>
+
+### Phase 3: User Stories
+
+For each module, create User Stories in: `docs/300-requirements/330-user-stories/33x-us-<module>-<feature>.md`
+
+<Module: <MODULE_FIRST>>
+- [ ] <US 1>: <Feature name>
+- [ ] <US 2>: <Feature name>
+- [ ] <US 3>: <Feature name>
+
+<Module: <MODULE_SECOND>>
+- [ ] <US 1>: <Feature name>
+- [ ] <US 2>: <Feature name>
+
+## Deliverables Summary
+
+### Phase 1 Deliverables
+- [x] This outline document
+- [x] Module dependency map
+- [x] Writing sequence plan
+
+### Phase 2 Deliverables (Per Module)
+- [ ] Module PRD document (`docs/300-requirements/31x-prd-<module>.md`)
+- [ ] Functional Requirements (FR-<MODULE>-<SEQ>)
+- [ ] Non-Functional Requirements (NFR-<MODULE>-<SEQ>)
+- [ ] Acceptance Criteria (AC-<MODULE>-<SEQ>)
+
+### Phase 3 Deliverables (Per User Story)
+- [ ] User Story document (`docs/300-requirements/330-user-stories/33x-us-<module>-<feature>.md`)
+- [ ] Comprehensive spec (8000+ words)
+- [ ] Detailed acceptance criteria
+- [ ] Data and metrics references
+- [ ] Security and audit requirements
+
+## Assumptions & Risks
+
+### Assumptions
+<List key assumptions about the project, stakeholders, timeline, etc.>
+
+### Risks
+<List potential risks that could impact requirements gathering or documentation>
+- <Risk 1>: <Description> | <Mitigation>
+- <Risk 2>: <Description> | <Mitigation>
+
+## References
+
+- Project Brief: `docs/200-product/201-project-brief.md`
+- Requirements Standards: `docs/100-standards/102-requirements-standards.md`
+- Documentation Standards: `docs/100-standards/101-documentation-standards.md`
+
+## Version History
+
+| Version | Date | Owner | Change |
+|---|---|---|---|
+| v0.1 | YYYY-MM-DD | PM | Initial requirements outline |