Skip to content

Commit c33c827

Browse files
jeremyederclaude
andcommitted
WIP: Add workflow status and notifications feature specification
- Create feature specification for GitHub issue #122 - Add workflow dashboard and notification system requirements - Define 14 functional requirements with 4 clarification needs - Configure markdownlint to disable line length and emphasis rules 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent a858253 commit c33c827

File tree

2 files changed

+146
-0
lines changed

2 files changed

+146
-0
lines changed

.markdownlint.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"MD013": false,
3+
"MD036": false
4+
}

specs/001-https-github-com/spec.md

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
# Feature Specification: Workflow Status and Notifications Dashboard
2+
3+
**Feature Branch**: `001-https-github-com`
4+
**Created**: 2025-09-24
5+
**Status**: Draft
6+
**Input**: User description: "<https://github.com/ambient-code/vTeam/issues/122>"
7+
8+
## Execution Flow (main)
9+
10+
```text
11+
1. Parse user description from Input
12+
� If empty: ERROR "No feature description provided"
13+
2. Extract key concepts from description
14+
� Identify: actors, actions, data, constraints
15+
3. For each unclear aspect:
16+
� Mark with [NEEDS CLARIFICATION: specific question]
17+
4. Fill User Scenarios & Testing section
18+
� If no clear user flow: ERROR "Cannot determine user scenarios"
19+
5. Generate Functional Requirements
20+
� Each requirement must be testable
21+
� Mark ambiguous requirements
22+
6. Identify Key Entities (if data involved)
23+
7. Run Review Checklist
24+
� If any [NEEDS CLARIFICATION]: WARN "Spec has uncertainties"
25+
� If implementation details found: ERROR "Remove tech details"
26+
8. Return: SUCCESS (spec ready for planning)
27+
```
28+
29+
---
30+
31+
## � Quick Guidelines
32+
33+
-  Focus on WHAT users need and WHY
34+
- L Avoid HOW to implement (no tech stack, APIs, code structure)
35+
- =e Written for business stakeholders, not developers
36+
37+
### Section Requirements
38+
39+
- **Mandatory sections**: Must be completed for every feature
40+
- **Optional sections**: Include only when relevant to the feature
41+
- When a section doesn't apply, remove it entirely (don't leave as "N/A")
42+
43+
### For AI Generation
44+
45+
When creating this spec from a user prompt:
46+
47+
1. **Mark all ambiguities**: Use [NEEDS CLARIFICATION: specific question] for any assumption you'd need to make
48+
2. **Don't guess**: If the prompt doesn't specify something (e.g., "login system" without auth method), mark it
49+
3. **Think like a tester**: Every vague requirement should fail the "testable and unambiguous" checklist item
50+
4. **Common underspecified areas**:
51+
- User types and permissions
52+
- Data retention/deletion policies
53+
- Performance targets and scale
54+
- Error handling behaviors
55+
- Integration requirements
56+
- Security/compliance needs
57+
58+
---
59+
60+
## User Scenarios & Testing *(mandatory)*
61+
62+
### Primary User Story
63+
64+
As a software development team member, I need a centralized dashboard that shows me the current status of all workflow activities so I can understand what work is available for me to pick up, what's currently in progress, and where bottlenecks might be occurring in our development process.
65+
66+
### Acceptance Scenarios
67+
68+
1. **Given** I am logged into the workflow dashboard, **When** I view the left-column workflow status, **Then** I can see the current status of all active workflows with time and cost metrics
69+
2. **Given** there is pending work assigned to me, **When** I check the notification system, **Then** I see an envelope icon indicating unread messages and can view the details of work waiting for my attention
70+
3. **Given** I complete a workflow step, **When** the system updates, **Then** the next team member receives a notification that work is ready for handoff
71+
4. **Given** I am viewing a workflow step, **When** I examine the metadata, **Then** I can see attribution information including time spent, cost incurred, and tools used (e.g., which LLM processed this step)
72+
73+
### Edge Cases
74+
75+
- What happens when a workflow step fails or times out?
76+
- How does the system handle conflicting work assignments or multiple people trying to claim the same task?
77+
- What occurs when notification delivery fails or team members are unavailable?
78+
79+
## Requirements *(mandatory)*
80+
81+
### Functional Requirements
82+
83+
- **FR-001**: System MUST display a left-column workflow dashboard showing current status of all active workflows
84+
- **FR-002**: System MUST show what workflow steps are next and what steps are waiting for action
85+
- **FR-003**: System MUST display per-step metrics including time spent and cost incurred
86+
- **FR-004**: System MUST show step attribution indicating which team member or system processed each step
87+
- **FR-005**: System MUST display metadata for each step including tools used (e.g., LLM model information)
88+
- **FR-006**: System MUST provide a notification system similar to GitHub inbox or Jira kanban board
89+
- **FR-007**: System MUST display a small envelope icon when there are unread messages or pending work items
90+
- **FR-008**: Team members MUST be able to view details of work waiting for their attention
91+
- **FR-009**: System MUST enable seamless work handoffs between team members
92+
- **FR-010**: System MUST provide real-time updates when workflow status changes
93+
- **FR-011**: System MUST authenticate users to ensure secure access to workflow information [NEEDS CLARIFICATION: authentication method not specified - SSO, email/password, existing system integration?]
94+
- **FR-012**: System MUST track workflow interactions between humans and computers [NEEDS CLARIFICATION: specific interaction types and data points to track not detailed]
95+
- **FR-013**: System MUST handle work assignment conflicts [NEEDS CLARIFICATION: conflict resolution mechanism not specified]
96+
- **FR-014**: System MUST define data retention policies [NEEDS CLARIFICATION: how long workflow data, metrics, and notifications should be retained]
97+
98+
### Key Entities *(include if feature involves data)*
99+
100+
- **Workflow**: Represents a sequence of steps in the software development process, contains status, current step, and overall progress information
101+
- **WorkflowStep**: Individual step within a workflow, includes time metrics, cost data, attribution, metadata, and completion status
102+
- **Notification**: Message or alert for team members, contains work item details, priority level, and read status
103+
- **TeamMember**: User who can interact with workflows, includes role information, notification preferences, and current work assignments
104+
- **WorkItem**: Unit of work that can be assigned and transferred between team members, contains description, status, and assignment history
105+
- **Metrics**: Performance data for workflow steps, includes time spent, cost calculations, and tool usage information
106+
107+
---
108+
109+
## Review & Acceptance Checklist
110+
111+
**GATE: Automated checks run during main() execution**
112+
113+
### Content Quality
114+
115+
- [x] No implementation details (languages, frameworks, APIs)
116+
- [x] Focused on user value and business needs
117+
- [x] Written for non-technical stakeholders
118+
- [x] All mandatory sections completed
119+
120+
### Requirement Completeness
121+
122+
- [ ] No [NEEDS CLARIFICATION] markers remain
123+
- [x] Requirements are testable and unambiguous
124+
- [x] Success criteria are measurable
125+
- [x] Scope is clearly bounded
126+
- [x] Dependencies and assumptions identified
127+
128+
---
129+
130+
## Execution Status
131+
132+
**Updated by main() during processing**
133+
134+
- [x] User description parsed
135+
- [x] Key concepts extracted
136+
- [x] Ambiguities marked
137+
- [x] User scenarios defined
138+
- [x] Requirements generated
139+
- [x] Entities identified
140+
- [ ] Review checklist passed (pending clarification resolution)
141+
142+
---

0 commit comments

Comments
 (0)