Writing Templates and Guides
This folder contains templates, checklists, and examples for Brainforge document types. Within the brainforge-platform repo, all paths are relative to the repo root.
Directory Structure
| Path | Contents |
|---|---|
standards/02-writing/Communications/ | Email and Slack templates |
standards/02-writing/Memos/ | Client-facing memo templates (findings, assessment, RCA, metrics) |
standards/02-writing/Memos/examples/ | Example memos by client/type |
standards/02-writing/PRDs/ | PRD template, checklist, and examples |
standards/02-writing/PRDs/examples/ | Example PRDs (e.g. prd-contextual-ai.md) |
standards/02-writing/Project-Setup/ | Meeting agendas, agents template, discovery wiki |
standards/02-writing/PLAYBOOK_SCAFFOLD.md | Canonical scaffold for reusable playbooks |
standards/02-writing/PLAYBOOK_INDEX.md | Registry of published and draft playbooks |
standards/02-writing/SOPs/ | SOP template |
| Linear board audit | Canonical SOP: knowledge/standards/04-prompts/tickets/linear-board-audit-sop.md; run via Cursor command /linear-audit or say “Linear audit” / “EP audit” in chat (rule: .cursor/rules/linear-audit.mdc). Full mode uses last 2 days + pre-audit meeting list; standard mode is summary-only. For Eden, scope to EdenOS/HealthOS/Rimo. |
| Weekly kick-off update | Canonical SOP: standards/04-prompts/weekly-kick-off-update-sop.md; run via Cursor command .cursor/commands/weekly-kick-off-update.md or say “Run weekly kick-off update” in chat. Asks for target client(s); produces draft (saved to knowledge/clients/{client}/meeting-notes/) and Slack-formatted summary per client. Uses last 7 days of transcripts + Linear. |
standards/02-writing/SOWs/ | SOW template, checklist |
standards/02-writing/SOWs/examples/ | Example SOWs by client/type |
standards/02-writing/*.md | Data platform doc template guide and prompts |
standards/02-writing/data-source-discovery-memo-new-share-playbook.md | Full discovery memo for a new share (confirm Snowflake vs BigQuery + auth + schema before profiling; structure, detail, anti-fluff). |
standards/02-writing/data-source-discovery-memo-update-playbook.md | Additive updates — ask for link/path to existing memo first; re-verify access; new §3 blocks; executive summary append-only. |
Key References
- Quick guide:
standards/02-writing/step-by-step-guide.md - Playbook scaffold:
standards/02-writing/PLAYBOOK_SCAFFOLD.md - Playbook registry:
standards/02-writing/PLAYBOOK_INDEX.md - Memo templates:
standards/02-writing/Memos/— four types: Data Findings, Technical Assessment, RCA, Metrics Definition - Data platform doc template:
standards/02-writing/data-platform-documentation-template-guide.mdanddata-platform-documentation-template-prompts.md(Claude in Excel) - Context source: Meeting notes and transcripts live in
knowledge/(internal) or client repos - Prompts:
standards/04-prompts/(sow, prd, sop, review, meetings)
When to Use a Memo
Memos are client-facing documents that sit between a status email (too lightweight) and a full SOW or PRD (too heavy). Use a memo when Brainforge has completed an investigation or evaluation and needs to communicate findings, decisions, and next steps to a client stakeholder.
| Memo type | Use when |
|---|---|
| Data Findings Memo | Investigating a data accuracy or quality issue; communicating root causes, fixes, and verified figures |
| Technical Assessment Memo | Evaluating tools, platforms, or architectural approaches; communicating a recommendation with rationale |
| Root Cause Analysis (RCA) Memo | Something broke or was wrong in production; communicating what happened, why, and how it is being prevented |
| Metrics Definition Document | Formalizing what a business metric means, how it is calculated, and what is excluded |
Related Paths (brainforge-platform)
- Vault (internal knowledge):
knowledge/ - Prompts (agent instructions):
standards/04-prompts/ - Humanizer skill:
.cursor/skills/humanizer/SKILL.md