factory/vibe/shareouts/README.md

vibe > Shareouts

Shareouts

Status: Active Last Updated: 2026-06-23 Related: vibe guidebooks · vibe runbooks

What a shareout is

A shareout captures something substantial that was done or seriously considered — the outcome of an ADR, a PRD, or an investigation — and packages it as a human-facing handout you can hand to a person to explain what happened and why it matters.

Where guidebooks are the standing reference map and runbooks are the procedures, a shareout is a moment-in-time communication artifact: "here is the thing we built / decided / explored, told for humans."

%%{init: {'theme': 'base'}}%%
flowchart LR
    classDef src fill:#2563eb,stroke:#1e40af,color:#fff
    classDef proc fill:#059669,stroke:#047857,color:#fff
    classDef store fill:#7c3aed,stroke:#6d28d9,color:#fff
    WORK["Substantial work<br>(ADR / PRD / investigation)"]:::src --> SO["Shareout<br>(dated handout folder)"]:::proc --> HUM["Humans<br>(read .md, deck, watch .mp4)"]:::store

1. Some substantial work lands — an ADR is decided, a PRD phase ships, an investigation concludes.
2. It is packaged into a dated shareout folder holding the human-facing handouts.
3. Humans consume the handout: a Markdown summary, a slide deck, and optionally a narrated video.

Convention: one dated subfolder per shareout

Important

Each shareout lives in its own dated subfolder named YYYY-MM-DD-slug/. The folder holds the human-facing handouts for that shareout: .md summaries, decks, and an optional .mp4.

The handouts inside a shareout folder can include:

• .md summaries — the written walkthrough (the folder's README.md is the front door).
• Decks — slides for presenting the work.
• Optional .mp4 — ffmpeg compilations of screenshots, Playwright captures, or a narrated explainer produced with the documentary-video skill.

Note

Handouts are written in FRENCH. The audience is humans, and the lab's human-facing audience is French-speaking. (This is the deliberate exception to the otherwise-English vibe/ tree, which exists for LLM agents.)

Index

Shareout	What it covers	Status
2026-06-23 · Vibe & safe-env	Mise en place du tronc vibe/ (guidebooks, runbooks, shareouts) et le PRD de l'environnement « safe prod-like »	✅ Active

Rules to contribute

1. One dated folder per shareout — YYYY-MM-DD-slug/, kebab-case slug, ISO date. Never dump loose files at this level.
2. Folder README.md is the front door — it carries the breadcrumb, a TL;DR, and links to every handout in the folder (deck, video, sub-summaries).
3. Handouts in French — the audience is human. (Reminder: the rest of vibe/ is English for agents.)
4. Add an index row here for every new shareout, with a one-line French summary and status, newest at the top.
5. Use the tree-docs skill for the breadcrumb spine and the per-folder README hub; use the documentary-video skill when a shareout warrants a narrated .mp4.
6. Bidirectional links — if a shareout points to an ADR/PRD/guidebook, link back from there. Descriptive link text only.
7. Status legend. ✅ done · 🟡 beta · 🔴 critical · ⚠️ known issue · ❌ disabled · ⬜ not started.