|
| 1 | +# Handover-Docs Methodology Survey — 2026-09-23 |
| 2 | + |
| 3 | +> **Status: decided — record-only; one durable lesson adopted into PROJECT_KNOWLEDGE.md, no skill or wording installed.** The object is `~/dev/handover-docs/` — a local, reusable **project handover documentation kit** (15 markdown files: README methodology, 9-volume handbook, ops SOPs, templates, glossary) written in Traditional Chinese. Its goal: a successor engineer with **no oral handover and no live support from the original team** can understand the system, operate it safely, and rebuild from zero using only repo docs. All content is templates and placeholders — no credentials, hosts, or real values exist in the kit; nothing sensitive was recorded. Guard: `plans/tests/test_handover_docs_survey_record.py`. |
| 4 | +
|
| 5 | +## Research Question |
| 6 | + |
| 7 | +User instruction: "Learn from @~/dev/handover-docs/ and beware about sensitive keywords (avoid recording them). Learn key knowledge from them" — then "record non-sensitive into docs or skills if worth it". Questions: (1) what the kit teaches that generalizes; (2) whether any pattern exposes a gap on an installed TeaPrompt surface; (3) what is worth recording and where. |
| 8 | + |
| 9 | +## Direct Recommendation (as of 2026-09-23) |
| 10 | + |
| 11 | +- **Adopt — one durable lesson into PROJECT_KNOWLEDGE.md.** The kit's five design principles are documentation-engineering contracts that transfer directly to how TeaPrompt writes and reviews records: contract-layer vs implementation-layer separation, snapshot dating with live-truth pointers, decision provenance, pitfalls-as-guards, plain-text artifacts. |
| 12 | +- **No new skill.** The kit is a *documentation structure*, not an executable workflow; TeaPrompt's `reflective-handoff-retro` already owns session-transfer, and the kit's task-card/agent-memory formats overlap with existing memory conventions. A skill would duplicate structure without a named local failure. |
| 13 | +- **Candidate for later:** if TeaPrompt ever produces handover docs for a product repo, the kit's nine-volume handbook order (01 business → 02 architecture → 03 data → 04 pipelines → 05 ops → 09 tests → 06 decisions → 07 state → 08 rebuild) is the proven sequence. |
| 14 | + |
| 15 | +## Method |
| 16 | + |
| 17 | +Coordinator read all 15 files in full (2026-09-23): `README.md`, `glossary.md`, `handbook/01-09`, `ops/secrets-management.md`, `ops/offsite-backup.md`, `templates/{task-card,incident-entry,agent-memory}.md`. No scouts, no panel. Sensitive-keyword audit: every file is template/placeholder text; no real values present. |
| 18 | + |
| 19 | +## Concept Map |
| 20 | + |
| 21 | +| ID | Concept | TeaPrompt coverage | Disposition | |
| 22 | +| --- | --- | --- | --- | |
| 23 | +| HD-1 | Contract-layer vs implementation-layer separation — every doc marks what a rebuild must preserve vs what can be dropped | `reflective-spec-plan` spec-vs-impl; verification-map `source_commit`/`last_verified_at` metadata | Adopted into PK lesson | |
| 24 | +| HD-2 | Snapshot docs carry 快照日期 + pointer to live truth (task-card `status:`) | PK lessons carry review triggers; Decision Index is the live pointer | Adopted into PK lesson | |
| 25 | +| HD-3 | Pitfalls written as guards, not warnings — 「無停止力的警告等於不存在」; silent failures get code guards cross-referenced from docs | `reflective-implement` Verification; ROUTE gates made failable 2026-09-23 (same principle) | Adopted into PK lesson | |
| 26 | +| HD-4 | Incident record: symptom ≠ root cause; root cause = "why the design allowed it"; detection delay is signal; 防護落點 names file:test | `06-repo/AGENTS.md` falsifiability; record-hygiene validator | Adopted into PK lesson | |
| 27 | +| HD-5 | Task cards: plain markdown, `status:` is live truth, `depends_on` graph, blocked names the specific external input, comments carry decision context | `plans/` records + Decision Index; no card system installed | No change — overlaps existing convention | |
| 28 | +| HD-6 | Acceptance as numbers — rebuild phases verify "these queries return these values", never "looks right"; un-rebuildable provenance declared | Verification-map acceptance.yaml; record-hygiene falsifiability | Adopted into PK lesson | |
| 29 | +| HD-7 | Secrets docs write location+procedure, never values; mount dirs not files (inode pinning); dual-source mismatch fails loud | Out of scope — TeaPrompt holds no secrets | No change (out of scope) | |
| 30 | +| HD-8 | Test-safety doc: danger declaration first, guard + bypass documented, disposable/live layering, test-data pollution policy | `09-running-tests.md` pattern; TeaPrompt tests are doc-only, no live env | No change — no live surface | |
| 31 | +| HD-9 | Agent-memory format: feedback/project/reference triage; write-in triggers; don't duplicate handbook knowledge | Mnemopi memory + `learn`/`retain` already serve this | No change — installed equivalent exists | |
| 32 | + |
| 33 | +## Candidate Adoption Ledger |
| 34 | + |
| 35 | +| ID | Candidate | Status | Evidence | Reopen trigger | |
| 36 | +| --- | --- | --- | --- | --- | |
| 37 | +| HD-1..4,6 | Five documentation-contract principles | Adopted — PK durable lesson | This record; PK lesson entry | A TeaPrompt doc that violates a principle (e.g. a warning-only pitfall, an undated snapshot) | |
| 38 | +| HD-5 | Task-card system | No change | `plans/` + Decision Index already provide provenance + live status | A project needing per-task cards outside the plans/ convention | |
| 39 | +| HD-7 | Secrets-management SOP | No change (out of scope) | TeaPrompt holds no credentials | TeaPrompt gains a secret-bearing surface | |
| 40 | +| HD-8 | Test-safety doc pattern | No change | No live-environment test surface exists | A test suite that can touch a live system | |
| 41 | +| HD-9 | Agent-memory format | No change | Mnemopi `retain`/`learn` + managed skills cover it | A gap in current memory conventions | |
| 42 | + |
| 43 | +## Evidence vs Inference |
| 44 | + |
| 45 | +| Claim | Status | Basis | |
| 46 | +| --- | --- | --- | |
| 47 | +| Kit structure and all quoted principles | Observed | All 15 files read in full, 2026-09-23 | |
| 48 | +| No sensitive values present | Observed | Every file is template/placeholder text | |
| 49 | +| HD-3 matches TeaPrompt's failable-gates principle | Observed | ROUTE gate fix commit 6b31ab1 same day | |
| 50 | +| The nine-volume order is "proven" | `[INFERENCE]` | README asserts it; no external validation of the ordering claim | |
| 51 | +| Kit's target audience is a no-oral-handover successor | Observed | README line 3–5 | |
| 52 | + |
| 53 | +## Evidence Actually Checked |
| 54 | + |
| 55 | +- `~/dev/handover-docs/` — all 15 files read in full, 2026-09-23. |
| 56 | +- TeaPrompt installed surfaces checked for overlap: `reflective-handoff-retro`, `reflective-spec-plan`, `reflective-implement` Verification, `validate_record_hygiene.py`, `PROJECT_KNOWLEDGE.md` lesson format. |
| 57 | +- Not done: no external validation of the methodology against a real handover; the kit is self-described. |
| 58 | + |
| 59 | +## Falsifiability |
| 60 | + |
| 61 | +- Wrong about "no sensitive values" if any file contains a real credential/host — all files read; all fields are placeholders. |
| 62 | +- Wrong about HD-5 overlap if `plans/` records lack live-status or provenance — both are enforced by `validate_record_hygiene.py` and the Decision Index. |
| 63 | +- The PK lesson is wrong if its principles contradict an installed contract — all five are consistent with existing verification/record conventions. |
| 64 | + |
| 65 | +## Completion Ledger |
| 66 | + |
| 67 | +| Item | Status | Evidence | |
| 68 | +| --- | --- | --- | |
| 69 | +| Kit read in full; sensitive-keyword audit clean | done | Method; Evidence vs Inference | |
| 70 | +| Nine concepts mapped; five adopted into PK lesson | done | Concept Map; Candidate Adoption Ledger | |
| 71 | +| PK durable lesson written | done | `PROJECT_KNOWLEDGE.md` | |
| 72 | +| Guard written | done | `plans/tests/test_handover_docs_survey_record.py` | |
| 73 | +| Full repository gate | done | `make all` from the repository root | |
0 commit comments