Brainforge Knowledge

CONTRIBUTING

3 min read

Contributing to the Brainforge Playbook

The Brainforge Playbook is the shared knowledge base for writing templates, examples, prompts usage guides, and reusable patterns across all Brainforge client projects.
To keep this repository clean, consistent, and useful for everyone, please follow the contribution guidelines below.

Purpose of This Repository

This repo is not for client-specific work.
It contains:

  • Reusable SOW / PRD / SOP templates
  • Sanitized examples
  • Writing guides and onboarding
  • Prompt usage documentation (but NOT the prompts themselves)
  • Consulting frameworks and industry knowledge
  • Internal case studies
  • Cross-client patterns and best practices

All real client artifacts (SOWs, PRDs, meeting notes, transcripts, pricing, scopes, etc.) must remain inside client-specific repos.

Before You Contribute

1. Make sure the content belongs here

A contribution belongs in the Playbook only if it is:

  • Reusable across multiple clients
  • Non-sensitive
  • Not tied to a specific client’s proprietary information
  • Helpful as a pattern, example, or template
  • An onboarding or process document

If the content contains real client details, it must be sanitized before being added here—or placed only in the client repo.

How to Contribute (Step-by-Step)

Step 1 — Open this repo in Cursor

  • File → Open Folder → select the brainforge-platform repo (playbook lives in standards/)

Step 2 — Create or edit the relevant file

Use Markdown (.md) for all content.

Step 3 — Follow the correct folder

Choose the correct folder based on the content:

  • onboarding/ → guides for new teammates
  • writing-standards/ → templates, checklists, reusable structures
  • prompts/ → documentation and usage instructions for Langfuse prompts
  • knowledge/ → consulting patterns, frameworks, industry overviews
  • case-studies/ → sanitized internal case studies

Step 4 — Use clear, simple writing

This repo serves many people, including non-technical users.
Use:

  • Short paragraphs
  • Clear explanations
  • Plainspoken tone
  • Avoid jargon unless defined

Step 5 — Commit your changes

In Cursor:

  1. Open the Source Control sidebar
  2. Add a commit message describing the change
  3. Click Commit

Step 6 — Push your changes

Click Push so the updates are uploaded to GitHub.

Content Rules

1. No client-specific or sensitive information

Do NOT include:

  • Names of real clients
  • Private pricing
  • Client transcripts or discovery notes
  • Proprietary architectures
  • Confidential strategy or roadmaps

Only sanitized, fictionalized, or generalized examples are allowed.

2. Templates must be generic

Templates should:

  • Avoid specifics
  • Use placeholders (e.g., [CLIENT], [GOAL], [SCOPE])
  • Represent Brainforge’s standard structure

3. Examples must be clearly marked as internal or public-ready

  • case-studies/internal/ → internal-only examples
  • case-studies/public-ready/ → sanitized for public release

4. Keep folders organized

Do not create new top-level folders without approval.
Place files where others intuitively expect to find them.

Updating Prompt Documentation

Prompts live in Langfuse, not in this repo.

If you update a Langfuse prompt:

  • Update the corresponding usage guide in prompts/
  • Reflect changes to input fields, expected outputs, or workflow
  • Never paste full prompt text into the repo
  • Reference prompt IDs like sow.generator.v1

This keeps the repo aligned without duplicating logic.

Writing Standards

All writing in this repo should follow Brainforge’s communication style:

  • Clear
  • Concise
  • Structured
  • Professional
  • Action-oriented
  • Easy for non-technical users

If unsure, ask Cursor:

“Rewrite this section to follow Brainforge writing standards.”

Final Checklist Before Submitting

  • Is this content reusable across clients?
  • Is it sanitized and free of client-identifiable information?
  • Is it placed in the correct folder?
  • Is it written clearly and simply?
  • Does it follow Markdown formatting?
  • Is the commit message clear?
  • Have you pushed the changes?
  • If the change relates to a Linear ticket, is the issue ID in the PR title (e.g. AMB-19) for integration sync?

If all answers are yes, you’re done.

Graph View