Add a root AGENTS.md (ecosystem map of factory/tools/cms + agent operating rules + the persona cohort & workflow) and a new vibe/ knowledge base for LLM agents, modeled on tree-docs conventions and the factory house style. vibe/ folders (each with a README hub + contribution rules): - ADR/ optimized MADR-lite; canonical home going forward (doc/adr stays historical) - PRD/ one subfolder per PRD, mandatory STATUS.md, QA strategy for big ones - investigations/ single INV-NNN-slug.md, or stub + folder w/ notebooks - guidebooks/ tree-docs maps; lab-ecosystem guidebook of factory+tools+cms - runbooks/ [AGENT]/[HUMAN] step procedures (EN; doc/runbooks stays FR) - shareouts/ dated FR handouts (decks/mp4) Seed content (first ADR + PRD): a safe, production-like environment to rehearse risky changes and recovery without touching real prod — local-only sandbox (k3d + arm64 VMs) with a hard prod/sandbox isolation boundary. Includes INV-001 (prod blast-radius couplings), the ecosystem guidebook, and a FR shareout. Conventions enforced: no-tombstone rule, breadcrumb spine, bidirectional cross-links, theme:base mermaid (MCP-validated) + ordered-list-after-diagram. Built with a Workflow + persona cohort; 24 files, zero dead links. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
67 lines
1.8 KiB
Markdown
67 lines
1.8 KiB
Markdown
[vibe](../README.md) > [Investigations](README.md) > **_template**
|
|
|
|
<!-- Copy this file to INV-NNN-slug.md, fill in, delete this note. -->
|
|
|
|
# INV-NNN: Title
|
|
|
|
> **Status**: In progress | Complete | Blocked
|
|
> **Date**: YYYY-MM-DD
|
|
> **Priority**: 🔴 High | 🟠 Medium | 🟡 Low
|
|
> **Related**: ADR-NNNN · PRD · upstream/downstream links
|
|
|
|
## Objectives
|
|
|
|
What this investigation set out to answer. Use checkboxes so progress is visible at a glance.
|
|
|
|
- [ ] Question or goal 1
|
|
- [ ] Question or goal 2
|
|
|
|
## Executive summary
|
|
|
|
Two or three sentences a busy reader can absorb without scrolling: what was investigated, what was found, and what (if anything) to do about it.
|
|
|
|
## Findings
|
|
|
|
Write each finding for diagonal reading: lead with the Brief, then evidence, then the bold Finding.
|
|
|
|
### 1. Finding title
|
|
|
|
**Brief.** One line stating what this section is about.
|
|
|
|
Evidence — the data, logs, code paths, commands, or reasoning that support the conclusion.
|
|
|
|
**Finding:** the bold takeaway. Tag with a classification emoji (🔴 / 🟠 / 🟡 / 🟢 / 🔵).
|
|
|
|
### 2. Finding title
|
|
|
|
**Brief.** ...
|
|
|
|
Evidence ...
|
|
|
|
**Finding:** ...
|
|
|
|
## Summary table
|
|
|
|
| # | Finding | Classification | Action |
|
|
| --- | --- | --- | --- |
|
|
| 1 | ... | 🟠 | ... |
|
|
| 2 | ... | 🟢 | ... |
|
|
|
|
## Classification
|
|
|
|
| Emoji | Meaning |
|
|
| --- | --- |
|
|
| 🔴 | Critical — data-loss or breaking risk confirmed |
|
|
| 🟠 | Significant — degraded but working, or a real coupling to watch |
|
|
| 🟡 | Minor — worth noting, low impact |
|
|
| 🟢 | Healthy — verified safe / no issue found |
|
|
| 🔵 | Informational — context, no action implied |
|
|
|
|
## Open questions
|
|
|
|
- Anything left unresolved, deferred, or needing a follow-up investigation.
|
|
|
|
## References
|
|
|
|
- Commands, files, PRs, ADRs, PRDs, or external docs consulted (descriptive link text, never "here"/"this").
|