Skip to content

Commit a7d7400

Browse files
committed
docs(workflow): add decision-capture workflow (Issue vs Docs routing)
1 parent dfb830d commit a7d7400

File tree

2 files changed

+108
-0
lines changed

2 files changed

+108
-0
lines changed

.tmp/traceflux-plan.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Traceflux Bootstrap Plan
2+
3+
**Status**: Temporary (delete after completion)
4+
5+
**Created**: 2026-03-13
6+
7+
---
8+
9+
## Goal
10+
11+
Use workflow-as-list to manage traceflux development, creating feedback loop.
12+
13+
---
14+
15+
## Phase 1: workflow-as-list Foundation
16+
17+
- [ ] Create Issue: "decision-capture workflow" proposal
18+
- [ ] Create `workflow/decision-capture.workflow.list`
19+
- [ ] Test: Process one real decision
20+
21+
---
22+
23+
## Phase 2: traceflux Setup
24+
25+
- [ ] `traceflux/workflow/README.md` (self-hosting purpose)
26+
- [ ] `traceflux/.github/ISSUE_TEMPLATE/decision.yml` (temporary decisions)
27+
- [ ] `traceflux/workflow/commit.workflow.list` (remote import test)
28+
- URL: `https://raw.githubusercontent.com/tracer-mohist/workflow-as-list/refs/heads/main/examples/git/commit.workflow.list`
29+
- [ ] `traceflux/scripts/check-code-quality.py` (adapt for traceflux)
30+
- [ ] `traceflux/scripts/check-docs-quality.py` (adapt for traceflux)
31+
32+
---
33+
34+
## Phase 3: Feedback Loop
35+
36+
- [ ] Use workflow to manage traceflux development
37+
- [ ] Record issues → Improve workflow-as-list
38+
- [ ] Document patterns
39+
40+
---
41+
42+
## Cleanup
43+
44+
- [ ] Delete `.tmp/` directory
45+
- [ ] Keep only permanent artifacts (workflows, templates)
46+
47+
---
48+
49+
## Principles
50+
51+
- Issue = Temporary decisions (short lifetime)
52+
- Docs = Permanent rules (functors, not instances)
53+
- Workflow = Automation of decision process
54+
55+
---
56+
57+
Last Updated: 2026-03-13
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# decision-capture.workflow.list
2+
# Purpose: Route information to correct destination (Issue vs Docs)
3+
#
4+
# Contract:
5+
# Pre: Have information/decision to record
6+
# Post: Information stored in appropriate place
7+
# Invariant: No decision lost, no docs polluted with tmp
8+
#
9+
# Philosophy:
10+
# Issue = Temporary decisions (short lifetime, project-specific)
11+
# Docs = Permanent rules (long lifetime, general principles)
12+
# Arrow: -> (ASCII, not unicode)
13+
14+
# WHY: Temporary decisions clutter docs, permanent ideas need docs not issues
15+
- (classify) Determine destination based on lifetime and scope
16+
- Ask: Will this be relevant in 6 months? (yes/no)
17+
- Ask: Is this project-specific or general? (specific/general)
18+
- Rule: If no OR specific -> Issue (temporary)
19+
- Rule: If yes AND general -> Docs (permanent)
20+
21+
# WHY: Issues have structure for decision tracking (labels, assignees, discussions)
22+
- (create-issue) If temporary decision:
23+
- Show: Available issue templates
24+
- Ask: Use decision.yml template? (yes/no)
25+
- If yes: Open GitHub issue with decision template
26+
- Fields: Title, Decision context, Options considered, Rationale
27+
- Tags: decision, tmp
28+
- Assign: Decision owner (optional)
29+
- Link: Related files/code (if any)
30+
31+
# WHY: Docs are for timeless rules (functors, not instances)
32+
- (update-docs) If permanent rule:
33+
- Ask: Which doc needs update? (README, docs/, workflow/)
34+
- Ask: What section? (or create new)
35+
- Format: Follow prompt-engineering principles
36+
- Commit: "docs: <decision summary>"
37+
- Push: Create PR if needed
38+
39+
# WHY: Decisions should be traceable bidirectionally
40+
- (link) Cross-reference issue and docs
41+
- If issue: Add link to related docs (if any) in issue description
42+
- If docs: Add link to decision issue (if any) in doc comments
43+
- Ask: Any related issues/PRs to link? (yes/no)
44+
45+
# WHY: Verify decision is properly recorded before moving on
46+
- (verify) Confirm recording is complete
47+
- If issue: Show issue URL, ask "Accessible and clear?" (yes/no)
48+
- If docs: Show git diff, ask "Changes accurate?" (yes/no)
49+
- If no: Fix before exiting
50+
51+
- End

0 commit comments

Comments
 (0)