blob: 40a04efe88b4cfab64dff02b3220a94b395b2740 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
# Work Directory
**Purpose:** Temporary working documents during development sessions
**Lifecycle:** Created during session → Archived at session end
**Status:** `.gitignore`d - not committed to version control
---
## What Goes Here
- Session summaries and notes
- Status reports and visual summaries
- Migration documentation (during migration)
- Planning documents
- Temporary analysis files
**Rule:** Nothing in this directory should be permanent. Archive or delete at session end.
---
## Workflow
### During Session
```bash
# Create working docs here
echo "Session notes..." > work/session-notes.md
echo "Status..." > work/status.md
```
### End of Session
```bash
# Archive important docs
mv work/session-notes.md docs/archive/2025-11-04-session-notes.md
# Delete obsolete docs
rm work/status.md
# Clean up
rm -rf work/*
```
---
## .gitignore
This directory is ignored by git (except this README):
```
work/*
!work/README.md
```
**Why:** Working documents are session-specific and shouldn't clutter the repository.
---
## Best Practices
**DO:**
- ✅ Use for temporary session work
- ✅ Use descriptive names
- ✅ Archive valuable content before deleting
- ✅ Clean up at session end
**DON'T:**
- ❌ Put permanent documentation here
- ❌ Reference work/ docs from permanent docs
- ❌ Commit work/ contents to git
- ❌ Let it accumulate files
---
## Alternative: Session-Specific Directories
For complex sessions, create dated subdirectories:
```bash
work/
├── 2025-11-04-diataxis-migration/
│ ├── notes.md
│ ├── checklist.md
│ └── visual-summary.txt
└── 2025-11-05-feature-x/
└── plan.md
```
Archive the entire directory when done:
```bash
tar czf docs/archive/2025-11-04-diataxis-migration.tar.gz work/2025-11-04-diataxis-migration/
rm -rf work/2025-11-04-diataxis-migration/
```
---
*This README is the only file in work/ committed to git.*
|