spec-kitty-cli 0.12.1__py3-none-any.whl
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.
- spec_kitty_cli-0.12.1.dist-info/METADATA +1767 -0
- spec_kitty_cli-0.12.1.dist-info/RECORD +242 -0
- spec_kitty_cli-0.12.1.dist-info/WHEEL +4 -0
- spec_kitty_cli-0.12.1.dist-info/entry_points.txt +2 -0
- spec_kitty_cli-0.12.1.dist-info/licenses/LICENSE +21 -0
- specify_cli/__init__.py +171 -0
- specify_cli/acceptance.py +627 -0
- specify_cli/agent_utils/README.md +157 -0
- specify_cli/agent_utils/__init__.py +9 -0
- specify_cli/agent_utils/status.py +356 -0
- specify_cli/cli/__init__.py +6 -0
- specify_cli/cli/commands/__init__.py +46 -0
- specify_cli/cli/commands/accept.py +189 -0
- specify_cli/cli/commands/agent/__init__.py +22 -0
- specify_cli/cli/commands/agent/config.py +382 -0
- specify_cli/cli/commands/agent/context.py +191 -0
- specify_cli/cli/commands/agent/feature.py +1057 -0
- specify_cli/cli/commands/agent/release.py +11 -0
- specify_cli/cli/commands/agent/tasks.py +1253 -0
- specify_cli/cli/commands/agent/workflow.py +801 -0
- specify_cli/cli/commands/context.py +246 -0
- specify_cli/cli/commands/dashboard.py +85 -0
- specify_cli/cli/commands/implement.py +973 -0
- specify_cli/cli/commands/init.py +827 -0
- specify_cli/cli/commands/init_help.py +62 -0
- specify_cli/cli/commands/merge.py +755 -0
- specify_cli/cli/commands/mission.py +240 -0
- specify_cli/cli/commands/ops.py +265 -0
- specify_cli/cli/commands/orchestrate.py +640 -0
- specify_cli/cli/commands/repair.py +175 -0
- specify_cli/cli/commands/research.py +165 -0
- specify_cli/cli/commands/sync.py +364 -0
- specify_cli/cli/commands/upgrade.py +249 -0
- specify_cli/cli/commands/validate_encoding.py +186 -0
- specify_cli/cli/commands/validate_tasks.py +186 -0
- specify_cli/cli/commands/verify.py +310 -0
- specify_cli/cli/helpers.py +123 -0
- specify_cli/cli/step_tracker.py +91 -0
- specify_cli/cli/ui.py +192 -0
- specify_cli/core/__init__.py +53 -0
- specify_cli/core/agent_context.py +311 -0
- specify_cli/core/config.py +96 -0
- specify_cli/core/context_validation.py +362 -0
- specify_cli/core/dependency_graph.py +351 -0
- specify_cli/core/git_ops.py +129 -0
- specify_cli/core/multi_parent_merge.py +323 -0
- specify_cli/core/paths.py +260 -0
- specify_cli/core/project_resolver.py +110 -0
- specify_cli/core/stale_detection.py +263 -0
- specify_cli/core/tool_checker.py +79 -0
- specify_cli/core/utils.py +43 -0
- specify_cli/core/vcs/__init__.py +114 -0
- specify_cli/core/vcs/detection.py +341 -0
- specify_cli/core/vcs/exceptions.py +85 -0
- specify_cli/core/vcs/git.py +1304 -0
- specify_cli/core/vcs/jujutsu.py +1208 -0
- specify_cli/core/vcs/protocol.py +285 -0
- specify_cli/core/vcs/types.py +249 -0
- specify_cli/core/version_checker.py +261 -0
- specify_cli/core/worktree.py +506 -0
- specify_cli/dashboard/__init__.py +28 -0
- specify_cli/dashboard/diagnostics.py +204 -0
- specify_cli/dashboard/handlers/__init__.py +17 -0
- specify_cli/dashboard/handlers/api.py +143 -0
- specify_cli/dashboard/handlers/base.py +65 -0
- specify_cli/dashboard/handlers/features.py +390 -0
- specify_cli/dashboard/handlers/router.py +81 -0
- specify_cli/dashboard/handlers/static.py +50 -0
- specify_cli/dashboard/lifecycle.py +541 -0
- specify_cli/dashboard/scanner.py +437 -0
- specify_cli/dashboard/server.py +123 -0
- specify_cli/dashboard/static/dashboard/dashboard.css +722 -0
- specify_cli/dashboard/static/dashboard/dashboard.js +1424 -0
- specify_cli/dashboard/static/spec-kitty.png +0 -0
- specify_cli/dashboard/templates/__init__.py +36 -0
- specify_cli/dashboard/templates/index.html +258 -0
- specify_cli/doc_generators.py +621 -0
- specify_cli/doc_state.py +408 -0
- specify_cli/frontmatter.py +384 -0
- specify_cli/gap_analysis.py +915 -0
- specify_cli/gitignore_manager.py +300 -0
- specify_cli/guards.py +145 -0
- specify_cli/legacy_detector.py +83 -0
- specify_cli/manifest.py +286 -0
- specify_cli/merge/__init__.py +63 -0
- specify_cli/merge/executor.py +653 -0
- specify_cli/merge/forecast.py +215 -0
- specify_cli/merge/ordering.py +126 -0
- specify_cli/merge/preflight.py +230 -0
- specify_cli/merge/state.py +185 -0
- specify_cli/merge/status_resolver.py +354 -0
- specify_cli/mission.py +654 -0
- specify_cli/missions/documentation/command-templates/implement.md +309 -0
- specify_cli/missions/documentation/command-templates/plan.md +275 -0
- specify_cli/missions/documentation/command-templates/review.md +344 -0
- specify_cli/missions/documentation/command-templates/specify.md +206 -0
- specify_cli/missions/documentation/command-templates/tasks.md +189 -0
- specify_cli/missions/documentation/mission.yaml +113 -0
- specify_cli/missions/documentation/templates/divio/explanation-template.md +192 -0
- specify_cli/missions/documentation/templates/divio/howto-template.md +168 -0
- specify_cli/missions/documentation/templates/divio/reference-template.md +179 -0
- specify_cli/missions/documentation/templates/divio/tutorial-template.md +146 -0
- specify_cli/missions/documentation/templates/generators/jsdoc.json.template +18 -0
- specify_cli/missions/documentation/templates/generators/sphinx-conf.py.template +36 -0
- specify_cli/missions/documentation/templates/plan-template.md +269 -0
- specify_cli/missions/documentation/templates/release-template.md +222 -0
- specify_cli/missions/documentation/templates/spec-template.md +172 -0
- specify_cli/missions/documentation/templates/task-prompt-template.md +140 -0
- specify_cli/missions/documentation/templates/tasks-template.md +159 -0
- specify_cli/missions/research/command-templates/merge.md +388 -0
- specify_cli/missions/research/command-templates/plan.md +125 -0
- specify_cli/missions/research/command-templates/review.md +144 -0
- specify_cli/missions/research/command-templates/tasks.md +225 -0
- specify_cli/missions/research/mission.yaml +115 -0
- specify_cli/missions/research/templates/data-model-template.md +33 -0
- specify_cli/missions/research/templates/plan-template.md +161 -0
- specify_cli/missions/research/templates/research/evidence-log.csv +18 -0
- specify_cli/missions/research/templates/research/source-register.csv +18 -0
- specify_cli/missions/research/templates/research-template.md +35 -0
- specify_cli/missions/research/templates/spec-template.md +64 -0
- specify_cli/missions/research/templates/task-prompt-template.md +148 -0
- specify_cli/missions/research/templates/tasks-template.md +114 -0
- specify_cli/missions/software-dev/command-templates/accept.md +75 -0
- specify_cli/missions/software-dev/command-templates/analyze.md +183 -0
- specify_cli/missions/software-dev/command-templates/checklist.md +286 -0
- specify_cli/missions/software-dev/command-templates/clarify.md +157 -0
- specify_cli/missions/software-dev/command-templates/constitution.md +432 -0
- specify_cli/missions/software-dev/command-templates/dashboard.md +101 -0
- specify_cli/missions/software-dev/command-templates/implement.md +41 -0
- specify_cli/missions/software-dev/command-templates/merge.md +383 -0
- specify_cli/missions/software-dev/command-templates/plan.md +171 -0
- specify_cli/missions/software-dev/command-templates/review.md +32 -0
- specify_cli/missions/software-dev/command-templates/specify.md +321 -0
- specify_cli/missions/software-dev/command-templates/tasks.md +566 -0
- specify_cli/missions/software-dev/mission.yaml +100 -0
- specify_cli/missions/software-dev/templates/plan-template.md +132 -0
- specify_cli/missions/software-dev/templates/spec-template.md +116 -0
- specify_cli/missions/software-dev/templates/task-prompt-template.md +140 -0
- specify_cli/missions/software-dev/templates/tasks-template.md +159 -0
- specify_cli/orchestrator/__init__.py +75 -0
- specify_cli/orchestrator/agent_config.py +224 -0
- specify_cli/orchestrator/agents/__init__.py +170 -0
- specify_cli/orchestrator/agents/augment.py +112 -0
- specify_cli/orchestrator/agents/base.py +243 -0
- specify_cli/orchestrator/agents/claude.py +112 -0
- specify_cli/orchestrator/agents/codex.py +106 -0
- specify_cli/orchestrator/agents/copilot.py +137 -0
- specify_cli/orchestrator/agents/cursor.py +139 -0
- specify_cli/orchestrator/agents/gemini.py +115 -0
- specify_cli/orchestrator/agents/kilocode.py +94 -0
- specify_cli/orchestrator/agents/opencode.py +132 -0
- specify_cli/orchestrator/agents/qwen.py +96 -0
- specify_cli/orchestrator/config.py +455 -0
- specify_cli/orchestrator/executor.py +642 -0
- specify_cli/orchestrator/integration.py +1230 -0
- specify_cli/orchestrator/monitor.py +898 -0
- specify_cli/orchestrator/scheduler.py +832 -0
- specify_cli/orchestrator/state.py +508 -0
- specify_cli/orchestrator/testing/__init__.py +122 -0
- specify_cli/orchestrator/testing/availability.py +346 -0
- specify_cli/orchestrator/testing/fixtures.py +684 -0
- specify_cli/orchestrator/testing/paths.py +218 -0
- specify_cli/plan_validation.py +107 -0
- specify_cli/scripts/debug-dashboard-scan.py +61 -0
- specify_cli/scripts/tasks/acceptance_support.py +695 -0
- specify_cli/scripts/tasks/task_helpers.py +506 -0
- specify_cli/scripts/tasks/tasks_cli.py +848 -0
- specify_cli/scripts/validate_encoding.py +180 -0
- specify_cli/task_metadata_validation.py +274 -0
- specify_cli/tasks_support.py +447 -0
- specify_cli/template/__init__.py +47 -0
- specify_cli/template/asset_generator.py +206 -0
- specify_cli/template/github_client.py +334 -0
- specify_cli/template/manager.py +193 -0
- specify_cli/template/renderer.py +99 -0
- specify_cli/templates/AGENTS.md +190 -0
- specify_cli/templates/POWERSHELL_SYNTAX.md +229 -0
- specify_cli/templates/agent-file-template.md +35 -0
- specify_cli/templates/checklist-template.md +42 -0
- specify_cli/templates/claudeignore-template +58 -0
- specify_cli/templates/command-templates/accept.md +141 -0
- specify_cli/templates/command-templates/analyze.md +253 -0
- specify_cli/templates/command-templates/checklist.md +352 -0
- specify_cli/templates/command-templates/clarify.md +224 -0
- specify_cli/templates/command-templates/constitution.md +432 -0
- specify_cli/templates/command-templates/dashboard.md +175 -0
- specify_cli/templates/command-templates/implement.md +190 -0
- specify_cli/templates/command-templates/merge.md +374 -0
- specify_cli/templates/command-templates/plan.md +171 -0
- specify_cli/templates/command-templates/research.md +88 -0
- specify_cli/templates/command-templates/review.md +510 -0
- specify_cli/templates/command-templates/specify.md +321 -0
- specify_cli/templates/command-templates/status.md +92 -0
- specify_cli/templates/command-templates/tasks.md +199 -0
- specify_cli/templates/git-hooks/pre-commit +22 -0
- specify_cli/templates/git-hooks/pre-commit-agent-check +37 -0
- specify_cli/templates/git-hooks/pre-commit-encoding-check +142 -0
- specify_cli/templates/plan-template.md +108 -0
- specify_cli/templates/spec-template.md +118 -0
- specify_cli/templates/task-prompt-template.md +165 -0
- specify_cli/templates/tasks-template.md +161 -0
- specify_cli/templates/vscode-settings.json +13 -0
- specify_cli/text_sanitization.py +225 -0
- specify_cli/upgrade/__init__.py +18 -0
- specify_cli/upgrade/detector.py +239 -0
- specify_cli/upgrade/metadata.py +182 -0
- specify_cli/upgrade/migrations/__init__.py +65 -0
- specify_cli/upgrade/migrations/base.py +80 -0
- specify_cli/upgrade/migrations/m_0_10_0_python_only.py +359 -0
- specify_cli/upgrade/migrations/m_0_10_12_constitution_cleanup.py +99 -0
- specify_cli/upgrade/migrations/m_0_10_14_update_implement_slash_command.py +176 -0
- specify_cli/upgrade/migrations/m_0_10_1_populate_slash_commands.py +174 -0
- specify_cli/upgrade/migrations/m_0_10_2_update_slash_commands.py +172 -0
- specify_cli/upgrade/migrations/m_0_10_6_workflow_simplification.py +174 -0
- specify_cli/upgrade/migrations/m_0_10_8_fix_memory_structure.py +252 -0
- specify_cli/upgrade/migrations/m_0_10_9_repair_templates.py +168 -0
- specify_cli/upgrade/migrations/m_0_11_0_workspace_per_wp.py +182 -0
- specify_cli/upgrade/migrations/m_0_11_1_improved_workflow_templates.py +173 -0
- specify_cli/upgrade/migrations/m_0_11_1_update_implement_slash_command.py +160 -0
- specify_cli/upgrade/migrations/m_0_11_2_improved_workflow_templates.py +173 -0
- specify_cli/upgrade/migrations/m_0_11_3_workflow_agent_flag.py +114 -0
- specify_cli/upgrade/migrations/m_0_12_0_documentation_mission.py +155 -0
- specify_cli/upgrade/migrations/m_0_12_1_remove_kitty_specs_from_gitignore.py +183 -0
- specify_cli/upgrade/migrations/m_0_2_0_specify_to_kittify.py +80 -0
- specify_cli/upgrade/migrations/m_0_4_8_gitignore_agents.py +118 -0
- specify_cli/upgrade/migrations/m_0_5_0_encoding_hooks.py +141 -0
- specify_cli/upgrade/migrations/m_0_6_5_commands_rename.py +169 -0
- specify_cli/upgrade/migrations/m_0_6_7_ensure_missions.py +228 -0
- specify_cli/upgrade/migrations/m_0_7_2_worktree_commands_dedup.py +89 -0
- specify_cli/upgrade/migrations/m_0_7_3_update_scripts.py +114 -0
- specify_cli/upgrade/migrations/m_0_8_0_remove_active_mission.py +82 -0
- specify_cli/upgrade/migrations/m_0_8_0_worktree_agents_symlink.py +148 -0
- specify_cli/upgrade/migrations/m_0_9_0_frontmatter_only_lanes.py +346 -0
- specify_cli/upgrade/migrations/m_0_9_1_complete_lane_migration.py +656 -0
- specify_cli/upgrade/migrations/m_0_9_2_research_mission_templates.py +221 -0
- specify_cli/upgrade/registry.py +121 -0
- specify_cli/upgrade/runner.py +284 -0
- specify_cli/validators/__init__.py +14 -0
- specify_cli/validators/paths.py +154 -0
- specify_cli/validators/research.py +428 -0
- specify_cli/verify_enhanced.py +270 -0
- specify_cli/workspace_context.py +224 -0
|
@@ -0,0 +1,225 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Generate research work packages with subtasks aligned to methodology phases.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Command Template: /spec-kitty.tasks (Research Mission)
|
|
6
|
+
|
|
7
|
+
**Phase**: Design (finalizing work breakdown)
|
|
8
|
+
**Purpose**: Break research work into independently executable work packages with subtasks.
|
|
9
|
+
|
|
10
|
+
## User Input
|
|
11
|
+
|
|
12
|
+
```text
|
|
13
|
+
$ARGUMENTS
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
You **MUST** consider the user input before proceeding (if not empty).
|
|
17
|
+
|
|
18
|
+
## Location Pre-flight Check
|
|
19
|
+
|
|
20
|
+
Verify you are in the main repository (not a worktree). Task generation happens in main for ALL missions.
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
git branch --show-current # Should show "main"
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
**Note**: Task generation in main is standard for all spec-kitty missions. Implementation happens in per-WP worktrees.
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## Outline
|
|
31
|
+
|
|
32
|
+
1. **Setup**: Run `spec-kitty agent feature check-prerequisites --json --paths-only --include-tasks`
|
|
33
|
+
|
|
34
|
+
**CRITICAL**: The command returns JSON with `FEATURE_DIR` as an ABSOLUTE path (e.g., `/Users/robert/Code/project/kitty-specs/015-research-topic`).
|
|
35
|
+
|
|
36
|
+
**YOU MUST USE THIS PATH** for ALL subsequent file operations.
|
|
37
|
+
|
|
38
|
+
2. **Load design documents**:
|
|
39
|
+
- spec.md (research question, scope, objectives)
|
|
40
|
+
- plan.md (methodology, phases, quality criteria)
|
|
41
|
+
- research.md (background, prior art)
|
|
42
|
+
- data-model.md (entities, relationships)
|
|
43
|
+
|
|
44
|
+
3. **Derive fine-grained subtasks**:
|
|
45
|
+
|
|
46
|
+
### Subtask Patterns for Research
|
|
47
|
+
|
|
48
|
+
**Literature Search & Source Collection** (Phase 1):
|
|
49
|
+
- T001: Define search keywords and inclusion/exclusion criteria
|
|
50
|
+
- T002: [P] Search academic database 1 (IEEE, PubMed, arXiv, etc.)
|
|
51
|
+
- T003: [P] Search academic database 2
|
|
52
|
+
- T004: [P] Search gray literature and industry sources
|
|
53
|
+
- T005: Screen collected sources for relevance
|
|
54
|
+
- T006: Populate source-register.csv with all candidate sources
|
|
55
|
+
- T007: Prioritize sources by relevance rating
|
|
56
|
+
|
|
57
|
+
**Source Review & Evidence Extraction** (Phase 2):
|
|
58
|
+
- T010: [P] Review high-relevance sources (parallelizable by source)
|
|
59
|
+
- T011: Extract key findings into evidence-log.csv
|
|
60
|
+
- T012: Assign confidence levels to findings
|
|
61
|
+
- T013: Document limitations and caveats
|
|
62
|
+
- T014: Identify patterns/themes emerging from evidence
|
|
63
|
+
|
|
64
|
+
**Analysis & Synthesis** (Phase 3):
|
|
65
|
+
- T020: Code findings by theme/category
|
|
66
|
+
- T021: Identify patterns across sources and confidence levels
|
|
67
|
+
- T022: Assess strength of evidence supporting each claim
|
|
68
|
+
- T023: Draw conclusions mapped to sub-questions
|
|
69
|
+
- T024: Document limitations and threats to validity
|
|
70
|
+
- T025: Write findings.md with synthesis and bibliography references
|
|
71
|
+
|
|
72
|
+
**Quality & Validation** (Phase 4):
|
|
73
|
+
- T030: Verify source coverage meets minimum requirements
|
|
74
|
+
- T031: Validate evidence citations are traceable
|
|
75
|
+
- T032: Check for bias in source selection
|
|
76
|
+
- T033: Review methodology adherence
|
|
77
|
+
- T034: External validation (if applicable)
|
|
78
|
+
|
|
79
|
+
4. **Roll subtasks into work packages**:
|
|
80
|
+
|
|
81
|
+
### Work Package Patterns for Research
|
|
82
|
+
|
|
83
|
+
**Standard Research Flow**:
|
|
84
|
+
- WP01: Literature Search & Source Collection (T001-T007)
|
|
85
|
+
- WP02: Source Review & Evidence Extraction (T010-T014)
|
|
86
|
+
- WP03: Analysis & Synthesis (T020-T025)
|
|
87
|
+
- WP04: Quality Validation (T030-T034)
|
|
88
|
+
|
|
89
|
+
**Empirical Research (if applicable)**:
|
|
90
|
+
- WP01: Literature Review (background, prior art)
|
|
91
|
+
- WP02: Study Design & Setup
|
|
92
|
+
- WP03: Data Collection
|
|
93
|
+
- WP04: Analysis & Findings
|
|
94
|
+
- WP05: Quality Validation
|
|
95
|
+
|
|
96
|
+
**Multi-Researcher Parallel**:
|
|
97
|
+
- WP01: Search & Collect (foundation)
|
|
98
|
+
- WP02a: [P] Source Review - Researcher 1 batch
|
|
99
|
+
- WP02b: [P] Source Review - Researcher 2 batch
|
|
100
|
+
- WP03: Synthesis (depends on WP02a, WP02b)
|
|
101
|
+
- WP04: Validation
|
|
102
|
+
|
|
103
|
+
### Prioritization
|
|
104
|
+
|
|
105
|
+
- **P0 (foundation)**: Literature search setup, source register initialization
|
|
106
|
+
- **P1 (critical)**: Source review, evidence extraction
|
|
107
|
+
- **P2 (important)**: Analysis, synthesis, findings
|
|
108
|
+
- **P3 (polish)**: Quality validation, external review
|
|
109
|
+
|
|
110
|
+
5. **Write `tasks.md`**:
|
|
111
|
+
- Location: `FEATURE_DIR/tasks.md`
|
|
112
|
+
- Use `templates/tasks-template.md` from research mission
|
|
113
|
+
- Include work packages with subtasks
|
|
114
|
+
- Mark parallel opportunities (`[P]`)
|
|
115
|
+
- Define dependencies (Phase 2 depends on Phase 1, etc.)
|
|
116
|
+
- Reference evidence tracking requirements (source-register.csv, evidence-log.csv)
|
|
117
|
+
|
|
118
|
+
6. **Generate prompt files**:
|
|
119
|
+
|
|
120
|
+
**CRITICAL PATH RULE**: All work package files MUST be created in a FLAT `FEATURE_DIR/tasks/` directory, NOT in subdirectories!
|
|
121
|
+
|
|
122
|
+
- Create flat `FEATURE_DIR/tasks/` directory (no subdirectories!)
|
|
123
|
+
- For each work package:
|
|
124
|
+
- Derive a kebab-case slug from the title; filename: `WPxx-slug.md`
|
|
125
|
+
- Full path: `FEATURE_DIR/tasks/WP01-literature-search.md`
|
|
126
|
+
- Use `templates/task-prompt-template.md` to capture:
|
|
127
|
+
- **YAML frontmatter with `lane: "planned"`** (CRITICAL - this is how review finds WPs!)
|
|
128
|
+
- `work_package_id`, `subtasks` array, `dependencies`, history entry
|
|
129
|
+
- Objectives, context, methodology guidance per subtask
|
|
130
|
+
- Evidence tracking requirements
|
|
131
|
+
- Quality validation criteria
|
|
132
|
+
|
|
133
|
+
**IMPORTANT**: All WP files live in flat `tasks/` directory. Lane status is tracked ONLY in the `lane:` frontmatter field, NOT by directory location. Agents can change lanes by editing the `lane:` field directly or using `spec-kitty agent tasks move-task`.
|
|
134
|
+
|
|
135
|
+
7. **Finalize tasks with dependency parsing and commit**:
|
|
136
|
+
|
|
137
|
+
**CRITICAL**: Run this command from repo root:
|
|
138
|
+
```bash
|
|
139
|
+
spec-kitty agent feature finalize-tasks --json
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
This step is MANDATORY. Without it:
|
|
143
|
+
- Dependencies won't be in frontmatter
|
|
144
|
+
- Tasks won't be committed to main
|
|
145
|
+
|
|
146
|
+
8. **Report**:
|
|
147
|
+
- Path to tasks.md
|
|
148
|
+
- Work package count and subtask tallies
|
|
149
|
+
- Parallelization opportunities (different sources, databases)
|
|
150
|
+
- MVP recommendation (typically WP01 Literature Search)
|
|
151
|
+
- Next command: `/spec-kitty.implement WP01`
|
|
152
|
+
|
|
153
|
+
---
|
|
154
|
+
|
|
155
|
+
## Research-Specific Task Generation Rules
|
|
156
|
+
|
|
157
|
+
**Evidence Tracking**:
|
|
158
|
+
- Every subtask that produces findings MUST specify output to evidence-log.csv
|
|
159
|
+
- Every subtask that identifies sources MUST specify output to source-register.csv
|
|
160
|
+
- Include subtasks for evidence validation and citation verification
|
|
161
|
+
|
|
162
|
+
**Parallel Opportunities**:
|
|
163
|
+
- Database searches are parallel (`[P]`) - different databases can be searched simultaneously
|
|
164
|
+
- Source reviews are parallel (`[P]`) - different sources can be reviewed simultaneously
|
|
165
|
+
- Researcher batches are parallel (`[P]`) - work can be split across reviewers
|
|
166
|
+
|
|
167
|
+
**Quality Subtasks**:
|
|
168
|
+
- Include confidence level assignment for findings
|
|
169
|
+
- Include bias checking for source selection
|
|
170
|
+
- Include methodology adherence verification
|
|
171
|
+
|
|
172
|
+
**Work Package Scope**:
|
|
173
|
+
- Each methodology phase typically gets its own work package
|
|
174
|
+
- Phase transitions are natural dependency boundaries
|
|
175
|
+
- Quality validation is always the final work package
|
|
176
|
+
|
|
177
|
+
---
|
|
178
|
+
|
|
179
|
+
## YAML Frontmatter Format (CRITICAL)
|
|
180
|
+
|
|
181
|
+
**Every WP prompt file MUST use this frontmatter format**:
|
|
182
|
+
|
|
183
|
+
```yaml
|
|
184
|
+
---
|
|
185
|
+
work_package_id: "WP01"
|
|
186
|
+
subtasks:
|
|
187
|
+
- "T001"
|
|
188
|
+
- "T002"
|
|
189
|
+
title: "Literature Search & Source Collection"
|
|
190
|
+
phase: "Phase 1 - Literature Review"
|
|
191
|
+
lane: "planned" # DO NOT EDIT - use: spec-kitty agent tasks move-task <WPID> --to <lane>
|
|
192
|
+
assignee: ""
|
|
193
|
+
agent: ""
|
|
194
|
+
shell_pid: ""
|
|
195
|
+
review_status: ""
|
|
196
|
+
reviewed_by: ""
|
|
197
|
+
dependencies: [] # Added by finalize-tasks
|
|
198
|
+
history:
|
|
199
|
+
- timestamp: "2026-01-19T00:00:00Z"
|
|
200
|
+
lane: "planned"
|
|
201
|
+
agent: "system"
|
|
202
|
+
shell_pid: ""
|
|
203
|
+
action: "Prompt generated via /spec-kitty.tasks"
|
|
204
|
+
---
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
**DO NOT use markdown status fields like `**Status**: planned`**. The `lane:` field in YAML frontmatter is the ONLY status tracking mechanism. The review command (`/spec-kitty.review`) searches for `lane: "for_review"` in frontmatter to find WPs ready for review.
|
|
208
|
+
|
|
209
|
+
---
|
|
210
|
+
|
|
211
|
+
## Key Guidelines
|
|
212
|
+
|
|
213
|
+
**For Agents**:
|
|
214
|
+
- Use methodology phases as natural WP boundaries
|
|
215
|
+
- Mark parallel subtasks (database searches, source reviews)
|
|
216
|
+
- Include evidence tracking in every WP prompt
|
|
217
|
+
- Quality validation depends on all content WPs
|
|
218
|
+
- Use `spec-kitty agent tasks move-task` to change lanes
|
|
219
|
+
|
|
220
|
+
**For Users**:
|
|
221
|
+
- Tasks.md shows the full research work breakdown
|
|
222
|
+
- Work packages follow methodology phases
|
|
223
|
+
- MVP is typically the literature search phase
|
|
224
|
+
- Parallel database searches speed up Phase 1
|
|
225
|
+
- Evidence artifacts (CSV files) are tracked throughout
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
name: "Deep Research Kitty"
|
|
2
|
+
description: "Conduct systematic research with structured methodology and evidence synthesis"
|
|
3
|
+
version: "1.0.0"
|
|
4
|
+
domain: "research"
|
|
5
|
+
|
|
6
|
+
# Workflow customization
|
|
7
|
+
workflow:
|
|
8
|
+
phases:
|
|
9
|
+
- name: "question"
|
|
10
|
+
description: "Define research question and scope"
|
|
11
|
+
- name: "methodology"
|
|
12
|
+
description: "Design research methodology"
|
|
13
|
+
- name: "gather"
|
|
14
|
+
description: "Collect data and sources"
|
|
15
|
+
- name: "analyze"
|
|
16
|
+
description: "Analyze findings"
|
|
17
|
+
- name: "synthesize"
|
|
18
|
+
description: "Synthesize results and draw conclusions"
|
|
19
|
+
- name: "publish"
|
|
20
|
+
description: "Prepare findings for publication"
|
|
21
|
+
|
|
22
|
+
# Expected artifacts
|
|
23
|
+
artifacts:
|
|
24
|
+
required:
|
|
25
|
+
- spec.md # Research question and scope
|
|
26
|
+
- plan.md # Methodology plan
|
|
27
|
+
- tasks.md # Research work packages
|
|
28
|
+
- findings.md # Synthesized findings
|
|
29
|
+
optional:
|
|
30
|
+
- sources/ # Source documents
|
|
31
|
+
- data/ # Raw data
|
|
32
|
+
- analysis/ # Analysis outputs
|
|
33
|
+
- literature-review.md # Optional extended literature review
|
|
34
|
+
- methodology.md # Detailed methodology appendix
|
|
35
|
+
- synthesis.md # Synthesis notes or drafts
|
|
36
|
+
|
|
37
|
+
# Path conventions for this mission
|
|
38
|
+
paths:
|
|
39
|
+
workspace: "research/"
|
|
40
|
+
data: "data/"
|
|
41
|
+
deliverables: "findings/"
|
|
42
|
+
documentation: "reports/"
|
|
43
|
+
|
|
44
|
+
# Validation rules
|
|
45
|
+
validation:
|
|
46
|
+
checks:
|
|
47
|
+
- all_sources_documented
|
|
48
|
+
- methodology_clear
|
|
49
|
+
- findings_synthesized
|
|
50
|
+
- no_unresolved_questions
|
|
51
|
+
custom_validators: true # Use validators.py
|
|
52
|
+
|
|
53
|
+
# MCP tools recommended for this mission
|
|
54
|
+
mcp_tools:
|
|
55
|
+
required:
|
|
56
|
+
- filesystem
|
|
57
|
+
- git
|
|
58
|
+
recommended:
|
|
59
|
+
- web-search
|
|
60
|
+
- pdf-reader
|
|
61
|
+
- citation-manager
|
|
62
|
+
- arxiv-search
|
|
63
|
+
optional:
|
|
64
|
+
- data-analysis
|
|
65
|
+
- statistics
|
|
66
|
+
- pubmed-search
|
|
67
|
+
|
|
68
|
+
# Agent personality/instructions
|
|
69
|
+
agent_context: |
|
|
70
|
+
You are a research agent conducting systematic literature reviews and empirical research.
|
|
71
|
+
Your mission is to maintain research integrity and methodological rigor throughout every phase.
|
|
72
|
+
|
|
73
|
+
Key Practices:
|
|
74
|
+
- Document ALL sources in research/source-register.csv with proper citations, URLs, and access dates.
|
|
75
|
+
- Extract findings to research/evidence-log.csv with confidence levels (high/medium/low) and contextual notes.
|
|
76
|
+
- Clearly articulate methodology decisions for reproducibility and peer review.
|
|
77
|
+
- Distinguish raw evidence from interpretation; cite every claim.
|
|
78
|
+
- Identify limitations, threats to validity, and alternative explanations.
|
|
79
|
+
- Synthesize findings so that each conclusion traces back to documented evidence rows.
|
|
80
|
+
|
|
81
|
+
Citation Standards:
|
|
82
|
+
- Use BibTeX or APA format (include DOI or URL when available).
|
|
83
|
+
- Track access dates for all online sources.
|
|
84
|
+
- Assign confidence levels commensurate with source quality.
|
|
85
|
+
|
|
86
|
+
Workflow Phases: question → methodology → gather → analyze → synthesize → publish.
|
|
87
|
+
|
|
88
|
+
# Task metadata fields
|
|
89
|
+
task_metadata:
|
|
90
|
+
required:
|
|
91
|
+
- task_id
|
|
92
|
+
- lane
|
|
93
|
+
- phase
|
|
94
|
+
- agent
|
|
95
|
+
optional:
|
|
96
|
+
- shell_pid
|
|
97
|
+
- assignee
|
|
98
|
+
- estimated_hours
|
|
99
|
+
- experiment_id
|
|
100
|
+
- data_collection_round
|
|
101
|
+
|
|
102
|
+
# Command customization
|
|
103
|
+
commands:
|
|
104
|
+
specify:
|
|
105
|
+
prompt: "Define research question, scope, and expected outcomes"
|
|
106
|
+
plan:
|
|
107
|
+
prompt: "Design research methodology and data collection strategy"
|
|
108
|
+
tasks:
|
|
109
|
+
prompt: "Break into research work packages (literature review, data collection, analysis)"
|
|
110
|
+
implement:
|
|
111
|
+
prompt: "Execute research plan and collect findings"
|
|
112
|
+
review:
|
|
113
|
+
prompt: "Review findings for validity, completeness, and proper documentation"
|
|
114
|
+
accept:
|
|
115
|
+
prompt: "Validate research completeness and readiness for publication"
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Data Model (Discovery Draft)
|
|
2
|
+
|
|
3
|
+
Use this skeleton to capture entities, attributes, and relationships uncovered during research. Update it as the solution space becomes clearer; implementation will refine and extend it.
|
|
4
|
+
|
|
5
|
+
## Entities
|
|
6
|
+
|
|
7
|
+
### Entity: <!-- e.g., Customer -->
|
|
8
|
+
- **Description**: <!-- Summary -->
|
|
9
|
+
- **Attributes**:
|
|
10
|
+
- `field_name` (type) – purpose / constraints
|
|
11
|
+
- **Identifiers**: <!-- Primary / alternate keys -->
|
|
12
|
+
- **Lifecycle Notes**: <!-- Creation, updates, archival -->
|
|
13
|
+
|
|
14
|
+
### Entity: <!-- e.g., Account -->
|
|
15
|
+
- **Description**:
|
|
16
|
+
- **Attributes**:
|
|
17
|
+
- `field_name` (type) – purpose / constraints
|
|
18
|
+
- **Identifiers**:
|
|
19
|
+
- **Lifecycle Notes**:
|
|
20
|
+
|
|
21
|
+
## Relationships
|
|
22
|
+
|
|
23
|
+
| Source | Relation | Target | Cardinality | Notes |
|
|
24
|
+
|--------|----------|--------|-------------|-------|
|
|
25
|
+
| <!-- e.g., Customer --> | <!-- owns --> | <!-- Account --> | <!-- 1:N --> | <!-- Business rules --> |
|
|
26
|
+
|
|
27
|
+
## Validation & Governance
|
|
28
|
+
|
|
29
|
+
- **Data quality requirements**: <!-- e.g., null-handling, accepted ranges -->
|
|
30
|
+
- **Compliance considerations**: <!-- PII, retention policies, regional restrictions -->
|
|
31
|
+
- **Source of truth**: <!-- Systems or datasets authoritative for each entity -->
|
|
32
|
+
|
|
33
|
+
> Treat this as a working model. When research uncovers new flows or systems, update the entities and relationships immediately so the implementation team inherits up-to-date context.
|
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
# Research Plan: [RESEARCH QUESTION]
|
|
2
|
+
|
|
3
|
+
**Branch**: `[###-research-name]` | **Date**: [DATE] | **Spec**: [link]
|
|
4
|
+
|
|
5
|
+
## Summary
|
|
6
|
+
[One paragraph: research question + methodology + expected outcomes]
|
|
7
|
+
|
|
8
|
+
## Research Context
|
|
9
|
+
|
|
10
|
+
**Research Question**: [Primary question]
|
|
11
|
+
**Research Type**: Literature Review | Empirical Study | Case Study
|
|
12
|
+
**Domain**: [Academic field or industry domain]
|
|
13
|
+
**Time Frame**: [When research will be conducted]
|
|
14
|
+
**Resources Available**: [Databases, tools, budget, time]
|
|
15
|
+
|
|
16
|
+
**Key Background**:
|
|
17
|
+
- [Context point 1]
|
|
18
|
+
- [Context point 2]
|
|
19
|
+
|
|
20
|
+
## Methodology
|
|
21
|
+
|
|
22
|
+
### Research Design
|
|
23
|
+
|
|
24
|
+
**Approach**: [Systematic Literature Review | Survey | Experiment | Mixed Methods]
|
|
25
|
+
|
|
26
|
+
**Phases**:
|
|
27
|
+
1. **Question Formation** (Week 1)
|
|
28
|
+
- Define precise research question
|
|
29
|
+
- Identify sub-questions
|
|
30
|
+
- Establish scope and boundaries
|
|
31
|
+
2. **Methodology Design** (Week 1-2)
|
|
32
|
+
- Select data collection methods
|
|
33
|
+
- Define analysis framework
|
|
34
|
+
- Establish quality criteria
|
|
35
|
+
3. **Data Gathering** (Week 2-4)
|
|
36
|
+
- Search academic databases
|
|
37
|
+
- Screen sources for relevance
|
|
38
|
+
- Extract key findings
|
|
39
|
+
- Populate `research/evidence-log.csv`
|
|
40
|
+
4. **Analysis** (Week 4-5)
|
|
41
|
+
- Code and categorize findings
|
|
42
|
+
- Identify patterns and themes
|
|
43
|
+
- Assess evidence quality
|
|
44
|
+
5. **Synthesis** (Week 5-6)
|
|
45
|
+
- Draw conclusions
|
|
46
|
+
- Address research question
|
|
47
|
+
- Identify limitations
|
|
48
|
+
6. **Publication** (Week 6)
|
|
49
|
+
- Write findings report
|
|
50
|
+
- Prepare presentation
|
|
51
|
+
- Share results
|
|
52
|
+
|
|
53
|
+
### Data Sources
|
|
54
|
+
|
|
55
|
+
**Primary Sources**:
|
|
56
|
+
- [Database 1: e.g., IEEE Xplore, PubMed, arXiv]
|
|
57
|
+
- [Database 2]
|
|
58
|
+
|
|
59
|
+
**Secondary Sources**:
|
|
60
|
+
- [Gray literature, industry reports, etc.]
|
|
61
|
+
|
|
62
|
+
**Search Strategy**:
|
|
63
|
+
- **Keywords**: [List search terms]
|
|
64
|
+
- **Inclusion Criteria**: [What qualifies for review]
|
|
65
|
+
- **Exclusion Criteria**: [What will be filtered out]
|
|
66
|
+
|
|
67
|
+
### Analysis Framework
|
|
68
|
+
|
|
69
|
+
**Coding Scheme**: [How findings will be categorized]
|
|
70
|
+
**Synthesis Method**: [Thematic analysis | Meta-analysis | Narrative synthesis]
|
|
71
|
+
**Quality Assessment**: [How source quality will be evaluated]
|
|
72
|
+
|
|
73
|
+
## Data Management
|
|
74
|
+
|
|
75
|
+
### Evidence Tracking
|
|
76
|
+
|
|
77
|
+
**File**: `research/evidence-log.csv`
|
|
78
|
+
**Purpose**: Track all evidence collected with citations and findings
|
|
79
|
+
|
|
80
|
+
**Columns**:
|
|
81
|
+
- `timestamp`: When evidence collected (ISO format)
|
|
82
|
+
- `source_type`: journal | conference | book | web | preprint
|
|
83
|
+
- `citation`: Full citation (BibTeX or APA format)
|
|
84
|
+
- `key_finding`: Main takeaway from this source
|
|
85
|
+
- `confidence`: high | medium | low
|
|
86
|
+
- `notes`: Additional context or caveats
|
|
87
|
+
|
|
88
|
+
**Agent Guidance**:
|
|
89
|
+
1. Read source and extract key finding.
|
|
90
|
+
2. Add row to evidence-log.csv.
|
|
91
|
+
3. Assign confidence level based on source quality and clarity.
|
|
92
|
+
4. Note limitations or alternative interpretations.
|
|
93
|
+
|
|
94
|
+
### Source Registry
|
|
95
|
+
|
|
96
|
+
**File**: `research/source-register.csv`
|
|
97
|
+
**Purpose**: Maintain master list of all sources for bibliography
|
|
98
|
+
|
|
99
|
+
**Columns**:
|
|
100
|
+
- `source_id`: Unique identifier (e.g., "smith2025")
|
|
101
|
+
- `citation`: Full citation
|
|
102
|
+
- `url`: Link to source (if available)
|
|
103
|
+
- `accessed_date`: When source was accessed
|
|
104
|
+
- `relevance`: high | medium | low
|
|
105
|
+
- `status`: reviewed | pending | archived
|
|
106
|
+
|
|
107
|
+
**Agent Guidance**:
|
|
108
|
+
1. Add source to register when first discovered.
|
|
109
|
+
2. Update status as research progresses.
|
|
110
|
+
3. Maintain relevance ratings to prioritize review.
|
|
111
|
+
|
|
112
|
+
## Project Structure
|
|
113
|
+
|
|
114
|
+
### Documentation (this research project)
|
|
115
|
+
```
|
|
116
|
+
kitty-specs/[###-research]/
|
|
117
|
+
├── spec.md # Research question and scope
|
|
118
|
+
├── plan.md # This file - methodology
|
|
119
|
+
├── tasks.md # Research work packages
|
|
120
|
+
├── findings.md # Research findings
|
|
121
|
+
├── research/
|
|
122
|
+
│ ├── evidence-log.csv # All evidence with citations
|
|
123
|
+
│ ├── source-register.csv # Master source list
|
|
124
|
+
│ └── methodology.md # Detailed methodology (optional)
|
|
125
|
+
└── data/ # Raw data (if empirical)
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
### Deliverables
|
|
129
|
+
```
|
|
130
|
+
findings/
|
|
131
|
+
├── report.md # Main research report
|
|
132
|
+
├── bibliography.md # Formatted bibliography
|
|
133
|
+
└── presentation/ # Slides or summary (optional)
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
## Quality Gates
|
|
137
|
+
|
|
138
|
+
### Before Data Gathering
|
|
139
|
+
- [ ] Research question is clear and focused
|
|
140
|
+
- [ ] Methodology is documented and reproducible
|
|
141
|
+
- [ ] Data sources identified and accessible
|
|
142
|
+
- [ ] Analysis framework defined
|
|
143
|
+
|
|
144
|
+
### During Data Gathering
|
|
145
|
+
- [ ] All sources documented in source-register.csv
|
|
146
|
+
- [ ] Evidence logged with proper citations
|
|
147
|
+
- [ ] Confidence levels assigned
|
|
148
|
+
- [ ] Quality threshold maintained
|
|
149
|
+
|
|
150
|
+
### Before Synthesis
|
|
151
|
+
- [ ] All sources reviewed
|
|
152
|
+
- [ ] Findings coded and categorized
|
|
153
|
+
- [ ] Patterns identified
|
|
154
|
+
- [ ] Limitations documented
|
|
155
|
+
|
|
156
|
+
### Before Publication
|
|
157
|
+
- [ ] Research question answered
|
|
158
|
+
- [ ] All claims cited
|
|
159
|
+
- [ ] Methodology clear and reproducible
|
|
160
|
+
- [ ] Findings synthesized
|
|
161
|
+
- [ ] Bibliography complete
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Evidence Log: Track all research findings with citations
|
|
2
|
+
#
|
|
3
|
+
# Column Definitions:
|
|
4
|
+
# - timestamp: When evidence was collected (ISO format: YYYY-MM-DDTHH:MM:SS)
|
|
5
|
+
# - source_type: journal | conference | book | web | preprint
|
|
6
|
+
# - citation: Full citation (BibTeX, APA, or Simple format)
|
|
7
|
+
# - key_finding: Main takeaway from this source (1-2 sentences)
|
|
8
|
+
# - confidence: high | medium | low (based on source quality and clarity)
|
|
9
|
+
# - notes: Additional context, caveats, or methodological notes
|
|
10
|
+
#
|
|
11
|
+
# Validation: Citations must be non-empty, source_type must be valid
|
|
12
|
+
# Format: BibTeX (@article{...}) or APA (Author (Year). Title.) recommended
|
|
13
|
+
timestamp,source_type,citation,key_finding,confidence,notes
|
|
14
|
+
2025-01-15T10:00:00,journal,"Smith, J. (2024). AI Code Assistants. Nature Comp Sci, 10(2), 123-145.",AI assistants improve productivity 30%,high,Meta-analysis of 50 peer-reviewed studies
|
|
15
|
+
2025-01-15T11:30:00,conference,"@inproceedings{jones2024copilot,author={Jones et al.},title={Copilot Study},booktitle={ICSE},year={2024}}",Copilot acceptance rate averages 65%,medium,GitHub internal usage study
|
|
16
|
+
2025-01-15T14:00:00,web,"GitHub Copilot Stats. https://github.blog/copilot-stats-2024",35M developers actively use Copilot,medium,Self-reported marketing data
|
|
17
|
+
2025-01-15T15:30:00,preprint,"Lee, K. (2024). AI Pair Programming. arXiv:2024.12345",Real-time suggestions reduce onboarding time,low,Preprint pending peer review
|
|
18
|
+
2025-01-16T09:00:00,book,"Brown, A. (2023). The AI Developer. O'Reilly Media.",Context-aware tools reduce cognitive load,high,Chapter 7 includes empirical study
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Source Register: Master list of all research sources
|
|
2
|
+
#
|
|
3
|
+
# Column Definitions:
|
|
4
|
+
# - source_id: Unique identifier (lowercase, no spaces, e.g., "smith2024")
|
|
5
|
+
# - citation: Full citation (BibTeX or APA format)
|
|
6
|
+
# - url: Direct link to source (DOI, arXiv, or web URL)
|
|
7
|
+
# - accessed_date: Date source was accessed (YYYY-MM-DD)
|
|
8
|
+
# - relevance: high | medium | low (to primary research question)
|
|
9
|
+
# - status: reviewed | pending | archived
|
|
10
|
+
#
|
|
11
|
+
# Usage: Add sources when discovered, update status as research progresses
|
|
12
|
+
# Validation: source_id must be unique
|
|
13
|
+
source_id,citation,url,accessed_date,relevance,status
|
|
14
|
+
smith2024,"Smith, J. (2024). AI Code Assistants. Nature Comp Sci, 10(2), 123-145.",https://doi.org/10.1038/example,2025-01-15,high,reviewed
|
|
15
|
+
jones2024,"@inproceedings{jones2024copilot,author={Jones et al.},title={Copilot Study},booktitle={ICSE 2024},year={2024}}",https://dl.acm.org/example,2025-01-15,high,reviewed
|
|
16
|
+
github2024,"GitHub Copilot Statistics. GitHub Blog.",https://github.blog/copilot-stats-2024,2025-01-15,medium,reviewed
|
|
17
|
+
lee2024,"Lee, K. (2024). AI Pair Programming. arXiv:2024.12345",https://arxiv.org/abs/2024.12345,2025-01-15,low,pending
|
|
18
|
+
brown2023,"Brown, A. (2023). The AI Developer: Human-Machine Collaboration. O'Reilly Media.",https://oreilly.com/example,2025-01-16,high,archived
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# Research Decision Log
|
|
2
|
+
|
|
3
|
+
Document the outcomes of Phase 0 discovery work. Capture every clarification you resolved and the supporting evidence that backs each decision.
|
|
4
|
+
|
|
5
|
+
## Summary
|
|
6
|
+
|
|
7
|
+
- **Feature**: <!-- e.g., 001-pii-detection-market -->
|
|
8
|
+
- **Date**: <!-- YYYY-MM-DD -->
|
|
9
|
+
- **Researchers**: <!-- Primary collaborators -->
|
|
10
|
+
- **Open Questions**: <!-- Items still unanswered after Phase 0 -->
|
|
11
|
+
|
|
12
|
+
## Decisions & Rationale
|
|
13
|
+
|
|
14
|
+
For each decision, include the supporting sources and why the team aligned on this direction.
|
|
15
|
+
|
|
16
|
+
| Decision | Rationale | Evidence | Status |
|
|
17
|
+
|----------|-----------|----------|--------|
|
|
18
|
+
| <!-- e.g., "Adopt vector database X" --> | <!-- Why this choice was made --> | <!-- Link to evidence rows / notes --> | <!-- final / follow-up --> |
|
|
19
|
+
|
|
20
|
+
## Evidence Highlights
|
|
21
|
+
|
|
22
|
+
Summarize the most impactful findings from the evidence log. Link back to specific rows so the trail is auditable.
|
|
23
|
+
|
|
24
|
+
- **Key insight 1** – <!-- Cite evidence row or page reference -->
|
|
25
|
+
- **Key insight 2** – <!-- Cite evidence row or page reference -->
|
|
26
|
+
- **Risks / Concerns** – <!-- Any red flags uncovered -->
|
|
27
|
+
|
|
28
|
+
## Next Actions
|
|
29
|
+
|
|
30
|
+
Outline what needs to happen before moving into implementation planning.
|
|
31
|
+
|
|
32
|
+
1. <!-- e.g., Validate data access with security team -->
|
|
33
|
+
2. <!-- e.g., Schedule stakeholder read-out -->
|
|
34
|
+
|
|
35
|
+
> Keep this document living. As more evidence arrives, update decisions and rationale so downstream implementers can trust the history.
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# Research Specification: [RESEARCH QUESTION]
|
|
2
|
+
|
|
3
|
+
**Feature Branch**: `[###-research-name]`
|
|
4
|
+
**Created**: [DATE]
|
|
5
|
+
**Status**: Draft
|
|
6
|
+
**Research Type**: Literature Review | Empirical Study | Case Study | Meta-Analysis
|
|
7
|
+
|
|
8
|
+
## Research Question & Scope
|
|
9
|
+
|
|
10
|
+
**Primary Research Question**: [What specific question does this research aim to answer?]
|
|
11
|
+
|
|
12
|
+
**Sub-Questions**:
|
|
13
|
+
1. [Supporting question 1]
|
|
14
|
+
2. [Supporting question 2]
|
|
15
|
+
|
|
16
|
+
**Scope**:
|
|
17
|
+
- **In Scope**: [What will be investigated]
|
|
18
|
+
- **Out of Scope**: [What will NOT be investigated]
|
|
19
|
+
- **Boundaries**: [Time period, geographic region, specific domains]
|
|
20
|
+
|
|
21
|
+
**Expected Outcomes**:
|
|
22
|
+
- [What findings or artifacts will this research produce?]
|
|
23
|
+
- [How will results be applied?]
|
|
24
|
+
|
|
25
|
+
## Research Methodology Outline
|
|
26
|
+
|
|
27
|
+
### Research Approach
|
|
28
|
+
- **Method**: Systematic Literature Review | Survey | Experiment | Case Study
|
|
29
|
+
- **Data Sources**: [Where will data / sources come from?]
|
|
30
|
+
- **Analysis Approach**: [How will data be analyzed?]
|
|
31
|
+
|
|
32
|
+
### Success Criteria
|
|
33
|
+
- [Measurable criterion 1: e.g., "Review at least 50 peer-reviewed sources"]
|
|
34
|
+
- [Measurable criterion 2: e.g., "Identify 3+ validated patterns"]
|
|
35
|
+
- [Quality criterion: e.g., "All sources cited in APA/BibTeX format"]
|
|
36
|
+
|
|
37
|
+
## Research Requirements
|
|
38
|
+
|
|
39
|
+
### Data Collection Requirements
|
|
40
|
+
- **DR-001**: Research MUST collect data from [specific sources]
|
|
41
|
+
- **DR-002**: All sources MUST be documented in `research/source-register.csv`
|
|
42
|
+
- **DR-003**: Citations MUST follow [BibTeX | APA | other] format
|
|
43
|
+
|
|
44
|
+
### Analysis Requirements
|
|
45
|
+
- **AR-001**: Findings MUST be synthesized into [specific output]
|
|
46
|
+
- **AR-002**: Methodology MUST be clearly documented and reproducible
|
|
47
|
+
- **AR-003**: Limitations MUST be explicitly identified
|
|
48
|
+
|
|
49
|
+
### Quality Requirements
|
|
50
|
+
- **QR-001**: All claims MUST be supported by cited evidence
|
|
51
|
+
- **QR-002**: Confidence levels MUST be assigned to findings in `research/evidence-log.csv`
|
|
52
|
+
- **QR-003**: Alternative interpretations MUST be considered
|
|
53
|
+
|
|
54
|
+
## Key Concepts & Terminology
|
|
55
|
+
|
|
56
|
+
- **[Concept 1]**: [Definition in research context]
|
|
57
|
+
- **[Concept 2]**: [Definition relevant to research question]
|
|
58
|
+
- **[Concept 3]**: [Any mission-specific terminology]
|
|
59
|
+
|
|
60
|
+
## Evidence Tracking Guidance
|
|
61
|
+
|
|
62
|
+
- Log every reviewed source in `research/source-register.csv` with citation, URL, relevance, and status.
|
|
63
|
+
- Capture each key finding in `research/evidence-log.csv`, including confidence level and notes.
|
|
64
|
+
- Reference evidence row IDs within this specification when making claims.
|