Skip to content

Commit 0ef4cd4

Browse files
committed
Rebrand "devlog entry" → "work item" across reorganization docs and add migration guidance
- Add TERMINOLOGY_REBRAND.md with rationale, options, mental model, and migration strategy - Introduce "work item" as the recommended term and document mapping (DevlogEntry → WorkItem) - Add guidance to create a type alias: `type WorkItem = DevlogEntry` and export it from core types for backward compatibility - Update CODEBASE_REORGANIZATION_SUMMARY.md, README.md, REORGANIZATION_PLAN.md, and QUICK_WINS.md to: - Promote "work item" terminology in examples, checklists, timelines, and target state visuals - Update API/route, UI, and MCP tooling naming (e.g. /work-items, mcp_work_item_create, mcp_work_item_update, etc.) - Add notes about preserving backward compatibility, deprecation path, and no immediate DB migrations - Adjust quick-win tasks and estimated times to include the terminology rebrand and exporting the WorkItem alias - Clarify UI/UX and code-structure tasks to rename/devise work-item locations (work-items vs devlog-entries) and maintain compatibility during phased migration
1 parent 5417a25 commit 0ef4cd4

File tree

5 files changed

+468
-72
lines changed

5 files changed

+468
-72
lines changed

CODEBASE_REORGANIZATION_SUMMARY.md

Lines changed: 28 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -34,21 +34,26 @@ I've created a comprehensive reorganization plan to help you clean up the codeba
3434
- Comprehensive design documentation
3535

3636
**⚠️ Clarity Issues:**
37-
- Mixed terminology creates confusion about product focus
38-
- Documentation emphasizes "devlog work tracking" over "agent observability"
37+
- Confusing terminology: "devlog entry" is not intuitive (→ rebrand to "work item")
38+
- Mixed priorities in documentation (work tracking vs. agent observability)
3939
- Code not organized by feature domains
4040
- READMEs don't reflect the new vision
4141

4242
### The Good News
4343

44-
Most of your "mess" is just **organizational, not technical debt**. You don't need to rewrite code - just reorganize and rebrand to match your new vision.
44+
Most of your "mess" is just **organizational, not technical debt**. You don't need to rewrite code - just reorganize, rebrand terminology, and restructure to match your new vision.
4545

4646
## 🚀 Recommended Approach
4747

4848
### Start with Quick Wins (This Week)
4949

5050
Focus on the high-impact, low-risk changes from [QUICK_WINS.md](./docs/dev/20251021-codebase-reorganization/QUICK_WINS.md):
5151

52+
**Priority 0: Terminology Rebrand (30 minutes)**
53+
- Add `type WorkItem = DevlogEntry` alias
54+
- Update documentation to use "work item" instead of "devlog entry"
55+
- Make terminology industry-standard and intuitive
56+
5257
**Day 1-2: Documentation (2-3 hours)**
5358
- Update root README.md to lead with AI agent observability
5459
- Update AGENTS.md with agent observability workflow
@@ -69,22 +74,25 @@ Focus on the high-impact, low-risk changes from [QUICK_WINS.md](./docs/dev/20251
6974
### Then Proceed with Full Reorganization (Next 3 Weeks)
7075

7176
Follow the [4-week plan](./docs/dev/20251021-codebase-reorganization/REORGANIZATION_PLAN.md):
72-
- **Week 2**: Move code to new structure
73-
- **Week 3**: Reorganize UI/UX
74-
- **Week 4**: Finalize APIs and integrations
77+
- **Week 1**: Documentation & terminology rebrand (work item)
78+
- **Week 2**: Move code to new structure
79+
- **Week 3**: Reorganize UI/UX (rename labels, update navigation)
80+
- **Week 4**: Finalize APIs and integrations (support both naming conventions)
7581

7682
## 📋 Immediate Next Actions
7783

7884
### 1. Review the Plans
85+
- [ ] Read [TERMINOLOGY_REBRAND.md](./docs/dev/20251021-codebase-reorganization/TERMINOLOGY_REBRAND.md) (5 minutes) - Why "work item"
7986
- [ ] Read [QUICK_WINS.md](./docs/dev/20251021-codebase-reorganization/QUICK_WINS.md) (10 minutes)
8087
- [ ] Skim [REORGANIZATION_PLAN.md](./docs/dev/20251021-codebase-reorganization/REORGANIZATION_PLAN.md) (20 minutes)
8188
- [ ] Decide if you agree with the approach
8289

8390
### 2. Start Quick Wins
8491
Pick one and start:
85-
- **Option A**: Update README.md (1 hour, highest impact)
86-
- **Option B**: Add service documentation (1 hour, improves code navigation)
87-
- **Option C**: Create folder structure (1 hour, sets foundation)
92+
- **Option A**: Add WorkItem type alias (5 minutes, enables gradual migration)
93+
- **Option B**: Update README.md (1 hour, highest impact)
94+
- **Option C**: Add service documentation (1 hour, improves code navigation)
95+
- **Option D**: Create folder structure (1 hour, sets foundation)
8896

8997
### 3. Track Progress
9098
Use the checklists in each document to track your progress.
@@ -95,6 +103,7 @@ Use the checklists in each document to track your progress.
95103
```
96104
devlog (work tracking tool)
97105
└── with some agent observability features
106+
└── "devlog entries" (confusing name)
98107
```
99108

100109
### Target State
@@ -108,31 +117,32 @@ AI Agent Observability Platform
108117
109118
└── Project management (SECONDARY - Supporting)
110119
├── Project organization
111-
└── Optional devlog entries
120+
└── Optional work items (features, bugs, tasks)
121+
└── Renamed from "devlog entries"
112122
```
113123

114124
## 💡 Key Insights
115125

116126
### 1. You Don't Need a Big Rewrite
117127
Your technical architecture is sound. You mainly need to:
118128
- **Reorganize** code into logical feature domains
119-
- **Rebrand** documentation to emphasize agent observability
129+
- **Rebrand** terminology ("work item" not "devlog entry")
120130
- **Restructure** UI to make agent features primary
121131

122132
### 2. Your Database Schema is Already Ready
123133
The Prisma schema already has:
124134
- `agent_events` table with proper indexes
125135
- `agent_sessions` table
126136
- Relationships to projects
127-
- No migrations needed!
137+
- No migrations needed! (table names can stay internal)
128138

129139
### 3. Services Exist, Just Need Organization
130140
You have:
131141
- `AgentEventService`
132142
- `AgentSessionService`
133143
- `ProjectService`
134144

135-
Just need to organize them clearly as "agent observability" (primary) vs "project management" (secondary).
145+
Just need to organize them clearly as "agent observability" (primary) vs "project management" (secondary), and rename devlog-service → work-item-service.
136146

137147
### 4. The Go Collector is Your Next Big Win
138148
After reorganization, focus on completing the Go collector (already 20% done). That's where the real value unlock happens.
@@ -155,25 +165,25 @@ packages/core/src/
155165
│ ├── sessions/
156166
│ └── analytics/
157167
├── project-management/ 📁 SECONDARY
158-
│ ├── devlog-entries/
168+
│ ├── work-items/ (renamed from devlog-entries)
159169
│ └── projects/
160170
└── services/ 🔧 CONSOLIDATED
161171
```
162172

163173
## ❓ Questions to Consider
164174

165175
1. **Repository Rename?**
166-
- Current: `devlog` (implies work tracking)
167-
- Consider: `agent-observatory`, `ai-agent-insights`, or keep `devlog` as brand name
176+
- Current: `devlog` (brand name)
177+
- Decision: **Keep "devlog" as brand**, just clarify what items inside are called ("work items")
168178

169179
2. **How Aggressive on Deprecation?**
170-
- Conservative: Keep everything, just reorganize
180+
- Conservative: Keep everything, just add aliases ✅ **Recommended**
171181
- Moderate: Mark old APIs as deprecated
172182
- Aggressive: Remove unused code
173183

174184
3. **Timeline Constraints?**
175185
- Can you dedicate 4 weeks to this?
176-
- Or prefer slower, incremental approach?
186+
- Or prefer slower, incremental approach?**Recommended - start with quick wins**
177187

178188
## 🎓 Learning from This
179189

docs/dev/20251021-codebase-reorganization/QUICK_WINS.md

Lines changed: 92 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,51 @@
22

33
**Goal**: Start reorganization with high-impact, low-risk changes that immediately improve code clarity.
44

5+
## 🎯 Priority 0: Terminology Rebrand (30 minutes)
6+
7+
Rename "devlog entry" to "work item" for better clarity and industry alignment.
8+
9+
### Why "Work Item"?
10+
- ✅ Industry standard (Azure DevOps, GitHub Projects)
11+
- ✅ Immediately understandable to developers
12+
- ✅ Versatile - works for features, bugs, tasks, refactors
13+
- ✅ Aligns with AI observability: "agents help complete work items"
14+
15+
### Quick Implementation
16+
17+
**1. Add Type Alias** (5 minutes)
18+
19+
**File**: `packages/core/src/types/core.ts`
20+
21+
Add at the top:
22+
```typescript
23+
/**
24+
* Work Item - Industry-standard terminology for trackable work
25+
* @deprecated Use WorkItem instead of DevlogEntry in new code
26+
*/
27+
export type WorkItem = DevlogEntry;
28+
```
29+
30+
**2. Update Package Exports** (5 minutes)
31+
32+
**File**: `packages/core/src/types/index.ts`
33+
34+
Add export:
35+
```typescript
36+
export type { WorkItem } from './core.js';
37+
```
38+
39+
**3. Document the Change** (20 minutes)
40+
41+
Add to README files and documentation:
42+
- "Track **work items** (features, bugs, tasks) alongside agent activities"
43+
- "Organize **work items** by project"
44+
- "See which **work items** AI agents are working on"
45+
46+
See [TERMINOLOGY_REBRAND.md](./TERMINOLOGY_REBRAND.md) for detailed migration plan.
47+
48+
---
49+
550
## 🎯 Priority 1: Documentation Updates (1-2 hours)
651

752
These changes immediately clarify the project vision without breaking any code.
@@ -29,7 +74,8 @@ These changes immediately clarify the project vision without breaking any code.
2974
mcp_agent_start_session({
3075
agentId: "github-copilot",
3176
projectId: 1,
32-
objective: "Implement user authentication"
77+
objective: "Implement user authentication",
78+
workItemId: 123 // Optional: link to work item
3379
});
3480

3581
// During work - events logged automatically by collector
@@ -46,6 +92,23 @@ mcp_agent_end_session({
4692
summary: "Implemented JWT-based auth with tests"
4793
});
4894
```
95+
96+
### When Managing Work Items (Optional)
97+
```
98+
// Create a work item to organize work
99+
mcp_work_item_create({
100+
title: "Implement user authentication",
101+
type: "feature",
102+
description: "Add JWT-based authentication system"
103+
});
104+
105+
// Update progress
106+
mcp_work_item_update({
107+
id: 123,
108+
status: "in-progress",
109+
note: "Completed login endpoint"
110+
});
111+
```
49112
```
50113

51114
### 3. Create Agent Observability Quick Start
@@ -172,9 +235,9 @@ Create `packages/core/src/project-management/index.ts`:
172235

173236
// Re-export from existing locations
174237
export * from '../services/project-service.js';
175-
export * from '../services/devlog-service.js';
238+
export * from '../services/devlog-service.js'; // TODO: rename to work-item-service
176239
export * from '../types/project.js';
177-
export * from '../types/devlog.js';
240+
export * from '../types/core.js'; // Includes WorkItem type alias
178241

179242
// TODO: Move actual files here in next phase
180243
```
@@ -247,8 +310,18 @@ export const agentObservabilityTools = [
247310

248311
export const projectManagementTools = [
249312
{
250-
name: 'mcp_devlog_create',
251-
description: '[PROJECT MANAGEMENT] Create a new devlog entry for work tracking...',
313+
name: 'mcp_work_item_create',
314+
description: '[PROJECT MANAGEMENT] Create a new work item (feature, bug, task) for tracking...',
315+
// ...
316+
},
317+
{
318+
name: 'mcp_work_item_update',
319+
description: '[PROJECT MANAGEMENT] Update a work item with progress, status changes...',
320+
// ...
321+
},
322+
{
323+
name: 'mcp_work_item_list',
324+
description: '[PROJECT MANAGEMENT] List and search work items with filters...',
252325
// ...
253326
},
254327
// ... more project tools
@@ -284,12 +357,12 @@ PRIMARY FEATURES - Agent Observability:
284357
• Code quality assessment for AI-generated code
285358
286359
SUPPORTING FEATURES - Project Management:
287-
• Optional work item tracking (devlog entries)
360+
• Optional work item tracking (features, bugs, tasks)
288361
• Project organization and context management
289362
• Documentation and note-taking
290363
291364
Use agent_* tools for observability features.
292-
Use devlog_* and project_* tools for project management.
365+
Use work_item_* and project_* tools for project management.
293366
`,
294367
},
295368
// ...
@@ -318,7 +391,7 @@ Core services and types for the AI Coding Agent Observability Platform.
318391

319392
### 📊 Project Management (Supporting)
320393
- **Project Organization**: Organize sessions by project
321-
- **Work Tracking**: Optional devlog entry system
394+
- **Work Item Tracking**: Optional system for tracking features, bugs, tasks
322395
- **Document Management**: Attach files and notes
323396

324397
## Usage
@@ -343,7 +416,8 @@ await AgentEventService.getInstance().logEvent({
343416

344417
### Project Management
345418
```typescript
346-
import { ProjectService, DevlogService } from '@codervisor/devlog-core/server';
419+
import { ProjectService, WorkItem } from '@codervisor/devlog-core/server';
420+
// Note: WorkItem is an alias for DevlogEntry for backward compatibility
347421

348422
// Manage projects
349423
const project = await ProjectService.getInstance().create({
@@ -363,6 +437,8 @@ const project = await ProjectService.getInstance().create({
363437
After completing quick wins:
364438
365439
- [ ] All README files emphasize agent observability as primary feature
440+
- [ ] "Work item" terminology used instead of "devlog entry"
441+
- [ ] WorkItem type alias exported from core package
366442
- [ ] Code comments clearly distinguish primary vs. secondary features
367443
- [ ] New folder structure exists (even if files not moved yet)
368444
- [ ] MCP tools are categorized by feature domain
@@ -382,7 +458,13 @@ After quick wins are complete:
382458
383459
## 📝 Estimated Time
384460
385-
- **Total**: 6-8 hours of focused work
461+
- **Total**: 6.5-8.5 hours of focused work
462+
- Priority 0 (Terminology): 30 minutes
463+
- Priority 1 (Documentation): 2-3 hours
464+
- Priority 2 (Code Comments): 1 hour
465+
- Priority 3 (File Organization): 2-3 hours
466+
- Priority 4 (MCP Tools): 1 hour
467+
- Priority 5 (READMEs): 1 hour
386468
- **Can be done incrementally**: Yes, each priority is independent
387469
- **Breaking changes**: None
388470
- **Risk level**: Very low

0 commit comments

Comments
 (0)