ai-spector 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +169 -0
- package/_templates/basic_design/db-design-template.md +177 -0
- package/_templates/basic_design/detail-api-template.md +278 -0
- package/_templates/basic_design/detail-screen-template.md +281 -0
- package/_templates/basic_design/list-api-template.md +130 -0
- package/_templates/basic_design/list-screen-template.md +242 -0
- package/_templates/detail_design/common/architecture-overview-template.md +302 -0
- package/_templates/detail_design/common/deployment-infrastructure-template.md +461 -0
- package/_templates/detail_design/common/error-handling-patterns-template.md +460 -0
- package/_templates/detail_design/common/integration-patterns-template.md +410 -0
- package/_templates/detail_design/common/performance-standards-template.md +406 -0
- package/_templates/detail_design/common/security-patterns-template.md +395 -0
- package/_templates/detail_design/feature-detail-design-template.md +773 -0
- package/_templates/detail_design/feature-list-template.md +39 -0
- package/_templates/srs/1-introduction.md +58 -0
- package/_templates/srs/2-overall-description.md +91 -0
- package/_templates/srs/3-use-case-detail-template.md +142 -0
- package/_templates/srs/3-use-cases.md +53 -0
- package/_templates/srs/4-system-feature-detail-template.md +131 -0
- package/_templates/srs/4-system-features-list-template.md +39 -0
- package/_templates/srs/5-data-requirements.md +59 -0
- package/_templates/srs/6-external-interfaces.md +56 -0
- package/_templates/srs/7-quality-attributes.md +74 -0
- package/_templates/srs/8-internationalization.md +36 -0
- package/_templates/srs/9-other-requirements.md +46 -0
- package/assets/cursor/commands/analyze.md +39 -0
- package/assets/cursor/commands/generate-detail-design.md +35 -0
- package/assets/cursor/commands/generate-srs.md +38 -0
- package/assets/cursor/skills/spec-writer/SKILL.md +33 -0
- package/assets/workflow/config/analyze.graphify.json +36 -0
- package/assets/workflow/config/completeness-rules.detail-design.json +57 -0
- package/assets/workflow/config/completeness-rules.srs.json +72 -0
- package/assets/workflow/config/dag.detail-design.json +64 -0
- package/assets/workflow/config/dag.srs.json +87 -0
- package/assets/workflow/state/state.template.json +26 -0
- package/assets/workflow/templates/basic_design/db-design-template.md +177 -0
- package/assets/workflow/templates/basic_design/detail-api-template.md +278 -0
- package/assets/workflow/templates/basic_design/detail-screen-template.md +281 -0
- package/assets/workflow/templates/basic_design/list-api-template.md +130 -0
- package/assets/workflow/templates/basic_design/list-screen-template.md +242 -0
- package/assets/workflow/templates/detail_design/common/architecture-overview-template.md +302 -0
- package/assets/workflow/templates/detail_design/common/deployment-infrastructure-template.md +461 -0
- package/assets/workflow/templates/detail_design/common/error-handling-patterns-template.md +460 -0
- package/assets/workflow/templates/detail_design/common/integration-patterns-template.md +410 -0
- package/assets/workflow/templates/detail_design/common/performance-standards-template.md +406 -0
- package/assets/workflow/templates/detail_design/common/security-patterns-template.md +395 -0
- package/assets/workflow/templates/detail_design/feature-detail-design-template.md +773 -0
- package/assets/workflow/templates/detail_design/feature-list-template.md +39 -0
- package/assets/workflow/templates/srs/1-introduction.md +58 -0
- package/assets/workflow/templates/srs/2-overall-description.md +91 -0
- package/assets/workflow/templates/srs/3-use-case-detail-template.md +142 -0
- package/assets/workflow/templates/srs/3-use-cases.md +53 -0
- package/assets/workflow/templates/srs/4-system-feature-detail-template.md +131 -0
- package/assets/workflow/templates/srs/4-system-features-list-template.md +39 -0
- package/assets/workflow/templates/srs/5-data-requirements.md +59 -0
- package/assets/workflow/templates/srs/6-external-interfaces.md +56 -0
- package/assets/workflow/templates/srs/7-quality-attributes.md +74 -0
- package/assets/workflow/templates/srs/8-internationalization.md +36 -0
- package/assets/workflow/templates/srs/9-other-requirements.md +46 -0
- package/bin/spec-writer.js +56 -0
- package/package.json +25 -0
- package/src/cli/helpers/fs.js +50 -0
- package/src/cli/init.js +178 -0
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
## 7. Non-Functional Requirements (Quality Attributes)
|
|
2
|
+
|
|
3
|
+
> This section specifies the non-functional requirements that define the quality attributes, constraints, and performance characteristics of the system. These requirements describe how the system should behave rather than what functions it should perform.
|
|
4
|
+
|
|
5
|
+
### 7.1 Usability
|
|
6
|
+
|
|
7
|
+
> Specify any requirements regarding characteristics that will make the software appear to be "user-friendly."
|
|
8
|
+
|
|
9
|
+
**Requirements:**
|
|
10
|
+
- **Ease of Use:** <Requirement>
|
|
11
|
+
- **Ease of Learning:** <Requirement>
|
|
12
|
+
- **Accessibility:** <Requirement>
|
|
13
|
+
- **Error Handling:** <Requirement>
|
|
14
|
+
|
|
15
|
+
**UI Design Standards:**
|
|
16
|
+
- <Standard 1>
|
|
17
|
+
- <Standard 2>
|
|
18
|
+
|
|
19
|
+
### 7.2 Performance
|
|
20
|
+
|
|
21
|
+
> State specific performance requirements for various system operations.
|
|
22
|
+
|
|
23
|
+
| Operation | Response Time Requirement |
|
|
24
|
+
|-----------|---------------------------|
|
|
25
|
+
| <Operation 1> | <Time requirement> |
|
|
26
|
+
| <Operation 2> | <Time requirement> |
|
|
27
|
+
|
|
28
|
+
**Throughput Requirements:**
|
|
29
|
+
- <Requirement 1>
|
|
30
|
+
- <Requirement 2>
|
|
31
|
+
|
|
32
|
+
### 7.3 Security
|
|
33
|
+
|
|
34
|
+
> Specify any requirements regarding security or privacy issues.
|
|
35
|
+
|
|
36
|
+
**Requirements:**
|
|
37
|
+
- **Access Control:** <Requirement>
|
|
38
|
+
- **Authentication:** <Requirement>
|
|
39
|
+
- **Authorization:** <Requirement>
|
|
40
|
+
- **Data Security:** <Requirement>
|
|
41
|
+
- **Privacy:** <Requirement>
|
|
42
|
+
|
|
43
|
+
**Compliance:**
|
|
44
|
+
- <Compliance requirement 1>
|
|
45
|
+
- <Compliance requirement 2>
|
|
46
|
+
|
|
47
|
+
### 7.4 Safety
|
|
48
|
+
|
|
49
|
+
> Specify requirements that are concerned with possible loss, damage, or harm.
|
|
50
|
+
|
|
51
|
+
**Requirements:**
|
|
52
|
+
- <Requirement 1>
|
|
53
|
+
- <Requirement 2>
|
|
54
|
+
|
|
55
|
+
**Safeguards:**
|
|
56
|
+
- <Safeguard 1>
|
|
57
|
+
- <Safeguard 2>
|
|
58
|
+
|
|
59
|
+
### 7.5 Others as relevant
|
|
60
|
+
|
|
61
|
+
> Create a separate section for each additional product quality attribute.
|
|
62
|
+
|
|
63
|
+
**Availability:**
|
|
64
|
+
- <Requirement 1>
|
|
65
|
+
- <Requirement 2>
|
|
66
|
+
|
|
67
|
+
**Reliability:**
|
|
68
|
+
- <Requirement 1>
|
|
69
|
+
- <Requirement 2>
|
|
70
|
+
|
|
71
|
+
**Maintainability:**
|
|
72
|
+
- <Requirement 1>
|
|
73
|
+
- <Requirement 2>
|
|
74
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
## 8. Internationalization and Localization Requirements
|
|
2
|
+
|
|
3
|
+
> Internationalization and localization requirements ensure that the product will be suitable for use in nations, cultures, and geographic locations other than those in which it was created.
|
|
4
|
+
|
|
5
|
+
**Supported Languages:**
|
|
6
|
+
|
|
7
|
+
- <Language 1>
|
|
8
|
+
- <Language 2>
|
|
9
|
+
|
|
10
|
+
**Supported Locales:**
|
|
11
|
+
|
|
12
|
+
- <Locale 1>
|
|
13
|
+
- <Locale 2>
|
|
14
|
+
|
|
15
|
+
**Formatting Requirements:**
|
|
16
|
+
|
|
17
|
+
- **Currency:**
|
|
18
|
+
- **Date/Time:**
|
|
19
|
+
- **Numbers:**
|
|
20
|
+
- **Addresses:**
|
|
21
|
+
|
|
22
|
+
**Character Sets:**
|
|
23
|
+
|
|
24
|
+
- <Requirement 1>
|
|
25
|
+
- <Requirement 2>
|
|
26
|
+
|
|
27
|
+
**Cultural Considerations:**
|
|
28
|
+
|
|
29
|
+
- <Consideration 1>
|
|
30
|
+
- <Consideration 2>
|
|
31
|
+
|
|
32
|
+
**Regulatory Compliance:**
|
|
33
|
+
|
|
34
|
+
- <Regulation 1>
|
|
35
|
+
- <Regulation 2>
|
|
36
|
+
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
## 9. Other Requirements
|
|
2
|
+
|
|
3
|
+
> Examples are: legal, regulatory or financial compliance, and standards requirements; requirements for product installation, configuration, startup, and shutdown; and logging, monitoring and audit trail requirements.
|
|
4
|
+
|
|
5
|
+
### 9.1 Legal and Regulatory Compliance
|
|
6
|
+
|
|
7
|
+
**Legal Requirements:**
|
|
8
|
+
- <Requirement 1>
|
|
9
|
+
- <Requirement 2>
|
|
10
|
+
|
|
11
|
+
**Regulatory Compliance:**
|
|
12
|
+
- <Compliance requirement 1>
|
|
13
|
+
- <Compliance requirement 2>
|
|
14
|
+
|
|
15
|
+
**Standards Compliance:**
|
|
16
|
+
- <Standard 1>
|
|
17
|
+
- <Standard 2>
|
|
18
|
+
|
|
19
|
+
### 9.2 Installation and Configuration
|
|
20
|
+
|
|
21
|
+
**Installation Requirements:**
|
|
22
|
+
- <Requirement 1>
|
|
23
|
+
- <Requirement 2>
|
|
24
|
+
|
|
25
|
+
**Configuration Requirements:**
|
|
26
|
+
- <Requirement 1>
|
|
27
|
+
- <Requirement 2>
|
|
28
|
+
|
|
29
|
+
**Startup/Shutdown Requirements:**
|
|
30
|
+
- <Requirement 1>
|
|
31
|
+
- <Requirement 2>
|
|
32
|
+
|
|
33
|
+
### 9.3 Logging and Monitoring
|
|
34
|
+
|
|
35
|
+
**Logging Requirements:**
|
|
36
|
+
- <Requirement 1>
|
|
37
|
+
- <Requirement 2>
|
|
38
|
+
|
|
39
|
+
**Monitoring Requirements:**
|
|
40
|
+
- <Requirement 1>
|
|
41
|
+
- <Requirement 2>
|
|
42
|
+
|
|
43
|
+
**Audit Trail Requirements:**
|
|
44
|
+
- <Requirement 1>
|
|
45
|
+
- <Requirement 2>
|
|
46
|
+
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# /analyze
|
|
2
|
+
|
|
3
|
+
Analyze project sources and produce normalized knowledge artifacts for downstream document generation.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
- `/analyze`
|
|
8
|
+
- Analyze current workspace folder.
|
|
9
|
+
- `/analyze <path1> <path2> ...`
|
|
10
|
+
- Analyze only provided files/folders.
|
|
11
|
+
|
|
12
|
+
## Required Behavior
|
|
13
|
+
|
|
14
|
+
1. Resolve and normalize input paths.
|
|
15
|
+
- If no path is provided, use workspace root as source.
|
|
16
|
+
- Skip invalid paths with warnings.
|
|
17
|
+
2. Build/update Graphify index through MCP.
|
|
18
|
+
3. Query graph to extract canonical sections:
|
|
19
|
+
- actors
|
|
20
|
+
- useCases
|
|
21
|
+
- features
|
|
22
|
+
- functionalRequirements
|
|
23
|
+
- nfrs
|
|
24
|
+
- entities
|
|
25
|
+
- interfaces
|
|
26
|
+
- constraints
|
|
27
|
+
- openQuestions
|
|
28
|
+
4. Use MCP text/semantic fallback when graph results are incomplete.
|
|
29
|
+
5. Persist artifacts:
|
|
30
|
+
- `docs/.docflow/analysis/knowledge.json`
|
|
31
|
+
- `docs/.docflow/analysis/gaps.json`
|
|
32
|
+
- `docs/.docflow/analysis/scope.json`
|
|
33
|
+
6. Update `docs/.docflow/state.json` with analysis timestamp and scope hash.
|
|
34
|
+
|
|
35
|
+
## Success Criteria
|
|
36
|
+
|
|
37
|
+
- Graphify contains current source scope.
|
|
38
|
+
- `knowledge.json` has all canonical keys.
|
|
39
|
+
- Missing information is explicit in `gaps.json`.
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# /generate-detail-design
|
|
2
|
+
|
|
3
|
+
Generate detail design documents incrementally from SRS + Graphify context with dependency-aware parallelism.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
- `/generate-detail-design`
|
|
8
|
+
- Continue mode: scan existing files and fill missing/incomplete outputs only.
|
|
9
|
+
- `/generate-detail-design <file>`
|
|
10
|
+
- Target a single detail-design file.
|
|
11
|
+
|
|
12
|
+
## Required Behavior
|
|
13
|
+
|
|
14
|
+
1. Load:
|
|
15
|
+
- `docs/.docflow/analysis/knowledge.json`
|
|
16
|
+
- `docs/output/srs/*`
|
|
17
|
+
- `docs/.docflow/config/dag.detail-design.json`
|
|
18
|
+
- `docs/.docflow/config/completeness-rules.detail-design.json`
|
|
19
|
+
2. Scan existing outputs under `docs/output/detail-design/` and classify:
|
|
20
|
+
- `good`
|
|
21
|
+
- `missing_content`
|
|
22
|
+
- `missing_file`
|
|
23
|
+
3. Process DAG in waves:
|
|
24
|
+
- generate or patch only `missing_content` and `missing_file`
|
|
25
|
+
- run independent nodes in parallel subagents
|
|
26
|
+
4. Merge each wave:
|
|
27
|
+
- verify consistency with SRS references
|
|
28
|
+
- normalize architecture/security/performance references
|
|
29
|
+
5. Sync each generated/updated file into Graphify immediately.
|
|
30
|
+
6. Persist updated state and run log.
|
|
31
|
+
|
|
32
|
+
## Guardrails
|
|
33
|
+
|
|
34
|
+
- Do not overwrite `good` files unless force mode is requested.
|
|
35
|
+
- If required SRS dependencies are absent, stop and request `/generate-srs` first.
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# /generate-srs
|
|
2
|
+
|
|
3
|
+
Generate SRS files incrementally in dependency order using templates, Graphify knowledge, and parallel subagents.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
- `/generate-srs`
|
|
8
|
+
- Continue mode by default: scan existing files and generate only missing/incomplete nodes.
|
|
9
|
+
- `/generate-srs <file>`
|
|
10
|
+
- Generate/repair one target file while validating prerequisites.
|
|
11
|
+
|
|
12
|
+
## Required Behavior
|
|
13
|
+
|
|
14
|
+
1. Load:
|
|
15
|
+
- `docs/.docflow/analysis/knowledge.json`
|
|
16
|
+
- `docs/.docflow/config/dag.srs.json`
|
|
17
|
+
- `docs/.docflow/config/completeness-rules.srs.json`
|
|
18
|
+
2. Scan existing outputs under `docs/output/srs/` and classify each target node:
|
|
19
|
+
- `good`
|
|
20
|
+
- `missing_content`
|
|
21
|
+
- `missing_file`
|
|
22
|
+
3. Skip `good` nodes by default.
|
|
23
|
+
4. Build generation queue by DAG wave order:
|
|
24
|
+
- process only `missing_file` and `missing_content`
|
|
25
|
+
- run independent nodes in parallel subagents
|
|
26
|
+
5. Merge and review each wave:
|
|
27
|
+
- normalize IDs and terminology
|
|
28
|
+
- validate links and cross references
|
|
29
|
+
- preserve manual content when patching existing files
|
|
30
|
+
6. After each written file, sync file content back into Graphify.
|
|
31
|
+
7. Update run logs and state:
|
|
32
|
+
- `docs/.docflow/logs/run-<timestamp>.md`
|
|
33
|
+
- `docs/.docflow/state.json`
|
|
34
|
+
|
|
35
|
+
## Guardrails
|
|
36
|
+
|
|
37
|
+
- Never overwrite `good` files unless force mode is requested.
|
|
38
|
+
- If analysis scope is stale or missing, request `/analyze` first.
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: spec-writer
|
|
3
|
+
description: "Incremental documentation workflow for analyze -> SRS -> detail design using Graphify MCP, dependency DAGs, and parallel subagents."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Spec Writer Skill
|
|
7
|
+
|
|
8
|
+
Use this skill when the user requests document generation from project data and templates.
|
|
9
|
+
|
|
10
|
+
## Workflow
|
|
11
|
+
|
|
12
|
+
1. Run `/analyze` to build and query Graphify knowledge for current scope.
|
|
13
|
+
2. Run `/generate-srs` to produce SRS documents in DAG order.
|
|
14
|
+
3. Run `/generate-detail-design` to produce detail design docs from SRS + Graphify context.
|
|
15
|
+
|
|
16
|
+
## Core Rules
|
|
17
|
+
|
|
18
|
+
- Always work incrementally.
|
|
19
|
+
- Scan outputs before generating and classify `good`, `missing_content`, `missing_file`.
|
|
20
|
+
- Skip `good` by default.
|
|
21
|
+
- Patch incomplete files rather than replacing valid sections.
|
|
22
|
+
- Generate independent nodes in parallel using subagents.
|
|
23
|
+
- Merge and normalize content in main agent after each wave.
|
|
24
|
+
- Sync generated files back into Graphify after each write.
|
|
25
|
+
|
|
26
|
+
## Inputs and Outputs
|
|
27
|
+
|
|
28
|
+
- Templates: `docs/_templates/*`
|
|
29
|
+
- Analysis artifacts: `docs/.docflow/analysis/*`
|
|
30
|
+
- Runtime state: `docs/.docflow/state.json`
|
|
31
|
+
- Outputs:
|
|
32
|
+
- `docs/output/srs/*`
|
|
33
|
+
- `docs/output/detail-design/*`
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 1,
|
|
3
|
+
"graphify": {
|
|
4
|
+
"indexPath": "docs/.docflow/graph/graphify-index",
|
|
5
|
+
"include": [
|
|
6
|
+
"."
|
|
7
|
+
],
|
|
8
|
+
"exclude": [
|
|
9
|
+
".git/**",
|
|
10
|
+
"node_modules/**",
|
|
11
|
+
"dist/**",
|
|
12
|
+
"build/**",
|
|
13
|
+
".next/**",
|
|
14
|
+
"coverage/**",
|
|
15
|
+
"docs/output/**"
|
|
16
|
+
]
|
|
17
|
+
},
|
|
18
|
+
"queryProfiles": [
|
|
19
|
+
{
|
|
20
|
+
"name": "actors-and-use-cases",
|
|
21
|
+
"goal": "Extract users, actors, and end-to-end use cases."
|
|
22
|
+
},
|
|
23
|
+
{
|
|
24
|
+
"name": "feature-map",
|
|
25
|
+
"goal": "Extract features, dependencies, and requirement groupings."
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
"name": "data-and-interfaces",
|
|
29
|
+
"goal": "Extract entities, data flows, and external/internal interfaces."
|
|
30
|
+
},
|
|
31
|
+
{
|
|
32
|
+
"name": "nfr-and-constraints",
|
|
33
|
+
"goal": "Extract quality attributes, constraints, and operational requirements."
|
|
34
|
+
}
|
|
35
|
+
]
|
|
36
|
+
}
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 1,
|
|
3
|
+
"defaultChecks": {
|
|
4
|
+
"disallowPlaceholders": [
|
|
5
|
+
"<",
|
|
6
|
+
"TODO",
|
|
7
|
+
"TBD"
|
|
8
|
+
],
|
|
9
|
+
"requireNonEmptyTables": true,
|
|
10
|
+
"validateMarkdownLinks": true
|
|
11
|
+
},
|
|
12
|
+
"rules": [
|
|
13
|
+
{
|
|
14
|
+
"target": "feature-list.md",
|
|
15
|
+
"requiredHeadings": [
|
|
16
|
+
"# Detail Design: Feature List",
|
|
17
|
+
"## 1. List of Features"
|
|
18
|
+
]
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
"target": "common/architecture-overview.md",
|
|
22
|
+
"requiredHeadings": [
|
|
23
|
+
"# Architecture Overview"
|
|
24
|
+
]
|
|
25
|
+
},
|
|
26
|
+
{
|
|
27
|
+
"target": "common/security-patterns.md",
|
|
28
|
+
"requiredHeadings": [
|
|
29
|
+
"# Security Patterns"
|
|
30
|
+
]
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
"target": "common/error-handling-patterns.md",
|
|
34
|
+
"requiredHeadings": [
|
|
35
|
+
"# Error Handling Patterns"
|
|
36
|
+
]
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
"target": "common/performance-standards.md",
|
|
40
|
+
"requiredHeadings": [
|
|
41
|
+
"# Performance Standards"
|
|
42
|
+
]
|
|
43
|
+
},
|
|
44
|
+
{
|
|
45
|
+
"target": "common/integration-patterns.md",
|
|
46
|
+
"requiredHeadings": [
|
|
47
|
+
"# Integration Patterns"
|
|
48
|
+
]
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
"target": "common/deployment-infrastructure.md",
|
|
52
|
+
"requiredHeadings": [
|
|
53
|
+
"# Deployment and Infrastructure"
|
|
54
|
+
]
|
|
55
|
+
}
|
|
56
|
+
]
|
|
57
|
+
}
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 1,
|
|
3
|
+
"defaultChecks": {
|
|
4
|
+
"disallowPlaceholders": [
|
|
5
|
+
"<",
|
|
6
|
+
"TODO",
|
|
7
|
+
"TBD"
|
|
8
|
+
],
|
|
9
|
+
"requireNonEmptyTables": true,
|
|
10
|
+
"validateMarkdownLinks": true
|
|
11
|
+
},
|
|
12
|
+
"rules": [
|
|
13
|
+
{
|
|
14
|
+
"target": "1-introduction.md",
|
|
15
|
+
"requiredHeadings": [
|
|
16
|
+
"## 1. Introduction",
|
|
17
|
+
"### 1.1 Document Purpose",
|
|
18
|
+
"### 1.3 Project Scope"
|
|
19
|
+
]
|
|
20
|
+
},
|
|
21
|
+
{
|
|
22
|
+
"target": "2-overall-description.md",
|
|
23
|
+
"requiredHeadings": [
|
|
24
|
+
"## 2. Overall Description"
|
|
25
|
+
]
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
"target": "3-use-cases.md",
|
|
29
|
+
"requiredHeadings": [
|
|
30
|
+
"## 3. Use Cases",
|
|
31
|
+
"### 3.1 Use Case Diagrams",
|
|
32
|
+
"### 3.2 List Use Case"
|
|
33
|
+
]
|
|
34
|
+
},
|
|
35
|
+
{
|
|
36
|
+
"target": "4-system-features.md",
|
|
37
|
+
"requiredHeadings": [
|
|
38
|
+
"## 4. System Features"
|
|
39
|
+
]
|
|
40
|
+
},
|
|
41
|
+
{
|
|
42
|
+
"target": "5-data-requirements.md",
|
|
43
|
+
"requiredHeadings": [
|
|
44
|
+
"## 5. Data Requirements"
|
|
45
|
+
]
|
|
46
|
+
},
|
|
47
|
+
{
|
|
48
|
+
"target": "6-external-interfaces.md",
|
|
49
|
+
"requiredHeadings": [
|
|
50
|
+
"## 6. External Interface Requirements"
|
|
51
|
+
]
|
|
52
|
+
},
|
|
53
|
+
{
|
|
54
|
+
"target": "7-quality-attributes.md",
|
|
55
|
+
"requiredHeadings": [
|
|
56
|
+
"## 7. Quality Attributes"
|
|
57
|
+
]
|
|
58
|
+
},
|
|
59
|
+
{
|
|
60
|
+
"target": "8-internationalization.md",
|
|
61
|
+
"requiredHeadings": [
|
|
62
|
+
"## 8. Internationalization and Localization"
|
|
63
|
+
]
|
|
64
|
+
},
|
|
65
|
+
{
|
|
66
|
+
"target": "9-other-requirements.md",
|
|
67
|
+
"requiredHeadings": [
|
|
68
|
+
"## 9. Other Requirements"
|
|
69
|
+
]
|
|
70
|
+
}
|
|
71
|
+
]
|
|
72
|
+
}
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 1,
|
|
3
|
+
"root": "docs/output/detail-design",
|
|
4
|
+
"nodes": [
|
|
5
|
+
{
|
|
6
|
+
"id": "dd.common.architecture-overview",
|
|
7
|
+
"template": "detail_design/common/architecture-overview-template.md",
|
|
8
|
+
"output": "common/architecture-overview.md",
|
|
9
|
+
"dependsOn": []
|
|
10
|
+
},
|
|
11
|
+
{
|
|
12
|
+
"id": "dd.common.security-patterns",
|
|
13
|
+
"template": "detail_design/common/security-patterns-template.md",
|
|
14
|
+
"output": "common/security-patterns.md",
|
|
15
|
+
"dependsOn": []
|
|
16
|
+
},
|
|
17
|
+
{
|
|
18
|
+
"id": "dd.common.error-handling",
|
|
19
|
+
"template": "detail_design/common/error-handling-patterns-template.md",
|
|
20
|
+
"output": "common/error-handling-patterns.md",
|
|
21
|
+
"dependsOn": []
|
|
22
|
+
},
|
|
23
|
+
{
|
|
24
|
+
"id": "dd.common.performance-standards",
|
|
25
|
+
"template": "detail_design/common/performance-standards-template.md",
|
|
26
|
+
"output": "common/performance-standards.md",
|
|
27
|
+
"dependsOn": []
|
|
28
|
+
},
|
|
29
|
+
{
|
|
30
|
+
"id": "dd.common.integration-patterns",
|
|
31
|
+
"template": "detail_design/common/integration-patterns-template.md",
|
|
32
|
+
"output": "common/integration-patterns.md",
|
|
33
|
+
"dependsOn": []
|
|
34
|
+
},
|
|
35
|
+
{
|
|
36
|
+
"id": "dd.common.deployment",
|
|
37
|
+
"template": "detail_design/common/deployment-infrastructure-template.md",
|
|
38
|
+
"output": "common/deployment-infrastructure.md",
|
|
39
|
+
"dependsOn": []
|
|
40
|
+
},
|
|
41
|
+
{
|
|
42
|
+
"id": "dd.feature-list",
|
|
43
|
+
"template": "detail_design/feature-list-template.md",
|
|
44
|
+
"output": "feature-list.md",
|
|
45
|
+
"dependsOn": [
|
|
46
|
+
"dd.common.architecture-overview",
|
|
47
|
+
"dd.common.security-patterns",
|
|
48
|
+
"dd.common.error-handling",
|
|
49
|
+
"dd.common.performance-standards",
|
|
50
|
+
"dd.common.integration-patterns",
|
|
51
|
+
"dd.common.deployment"
|
|
52
|
+
]
|
|
53
|
+
},
|
|
54
|
+
{
|
|
55
|
+
"id": "dd.feature-details",
|
|
56
|
+
"template": "detail_design/feature-detail-design-template.md",
|
|
57
|
+
"output": "features/",
|
|
58
|
+
"dependsOn": [
|
|
59
|
+
"dd.feature-list"
|
|
60
|
+
],
|
|
61
|
+
"mode": "perFeature"
|
|
62
|
+
}
|
|
63
|
+
]
|
|
64
|
+
}
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 1,
|
|
3
|
+
"root": "docs/output/srs",
|
|
4
|
+
"nodes": [
|
|
5
|
+
{
|
|
6
|
+
"id": "srs.introduction",
|
|
7
|
+
"template": "srs/1-introduction.md",
|
|
8
|
+
"output": "1-introduction.md",
|
|
9
|
+
"dependsOn": []
|
|
10
|
+
},
|
|
11
|
+
{
|
|
12
|
+
"id": "srs.overall-description",
|
|
13
|
+
"template": "srs/2-overall-description.md",
|
|
14
|
+
"output": "2-overall-description.md",
|
|
15
|
+
"dependsOn": []
|
|
16
|
+
},
|
|
17
|
+
{
|
|
18
|
+
"id": "srs.use-cases",
|
|
19
|
+
"template": "srs/3-use-cases.md",
|
|
20
|
+
"output": "3-use-cases.md",
|
|
21
|
+
"dependsOn": [
|
|
22
|
+
"srs.introduction",
|
|
23
|
+
"srs.overall-description"
|
|
24
|
+
]
|
|
25
|
+
},
|
|
26
|
+
{
|
|
27
|
+
"id": "srs.features-list",
|
|
28
|
+
"template": "srs/4-system-features-list-template.md",
|
|
29
|
+
"output": "4-system-features.md",
|
|
30
|
+
"dependsOn": [
|
|
31
|
+
"srs.use-cases"
|
|
32
|
+
]
|
|
33
|
+
},
|
|
34
|
+
{
|
|
35
|
+
"id": "srs.feature-details",
|
|
36
|
+
"template": "srs/4-system-feature-detail-template.md",
|
|
37
|
+
"output": "features/",
|
|
38
|
+
"dependsOn": [
|
|
39
|
+
"srs.features-list"
|
|
40
|
+
],
|
|
41
|
+
"mode": "perFeature"
|
|
42
|
+
},
|
|
43
|
+
{
|
|
44
|
+
"id": "srs.data-requirements",
|
|
45
|
+
"template": "srs/5-data-requirements.md",
|
|
46
|
+
"output": "5-data-requirements.md",
|
|
47
|
+
"dependsOn": [
|
|
48
|
+
"srs.feature-details"
|
|
49
|
+
]
|
|
50
|
+
},
|
|
51
|
+
{
|
|
52
|
+
"id": "srs.external-interfaces",
|
|
53
|
+
"template": "srs/6-external-interfaces.md",
|
|
54
|
+
"output": "6-external-interfaces.md",
|
|
55
|
+
"dependsOn": [
|
|
56
|
+
"srs.feature-details"
|
|
57
|
+
]
|
|
58
|
+
},
|
|
59
|
+
{
|
|
60
|
+
"id": "srs.quality-attributes",
|
|
61
|
+
"template": "srs/7-quality-attributes.md",
|
|
62
|
+
"output": "7-quality-attributes.md",
|
|
63
|
+
"dependsOn": [
|
|
64
|
+
"srs.data-requirements",
|
|
65
|
+
"srs.external-interfaces"
|
|
66
|
+
]
|
|
67
|
+
},
|
|
68
|
+
{
|
|
69
|
+
"id": "srs.internationalization",
|
|
70
|
+
"template": "srs/8-internationalization.md",
|
|
71
|
+
"output": "8-internationalization.md",
|
|
72
|
+
"dependsOn": [
|
|
73
|
+
"srs.data-requirements",
|
|
74
|
+
"srs.external-interfaces"
|
|
75
|
+
]
|
|
76
|
+
},
|
|
77
|
+
{
|
|
78
|
+
"id": "srs.other-requirements",
|
|
79
|
+
"template": "srs/9-other-requirements.md",
|
|
80
|
+
"output": "9-other-requirements.md",
|
|
81
|
+
"dependsOn": [
|
|
82
|
+
"srs.data-requirements",
|
|
83
|
+
"srs.external-interfaces"
|
|
84
|
+
]
|
|
85
|
+
}
|
|
86
|
+
]
|
|
87
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 1,
|
|
3
|
+
"analysis": {
|
|
4
|
+
"lastRunAt": null,
|
|
5
|
+
"scopeHash": null,
|
|
6
|
+
"sources": []
|
|
7
|
+
},
|
|
8
|
+
"graphify": {
|
|
9
|
+
"ready": false,
|
|
10
|
+
"installedByInit": false,
|
|
11
|
+
"lastBootstrapAt": null,
|
|
12
|
+
"lastSyncedFiles": []
|
|
13
|
+
},
|
|
14
|
+
"srs": {
|
|
15
|
+
"completed": [],
|
|
16
|
+
"inProgress": [],
|
|
17
|
+
"failed": [],
|
|
18
|
+
"artifacts": {}
|
|
19
|
+
},
|
|
20
|
+
"detailDesign": {
|
|
21
|
+
"completed": [],
|
|
22
|
+
"inProgress": [],
|
|
23
|
+
"failed": [],
|
|
24
|
+
"artifacts": {}
|
|
25
|
+
}
|
|
26
|
+
}
|