upleb.uk

Public git repos — served from a NIP-34 GRASP relay at git.upleb.uk

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