Brand & Templates¶

BrainSAIT Documentation Standards & Resources

Overview¶

This section contains brand guidelines, documentation templates, and standards for creating consistent BrainSAIT documentation.

Document Templates¶

Product Documentation¶

Process Documentation¶

Brand Identity¶

Company Information¶

Brand Colors¶

Typography¶

Documentation Standards¶

YAML Frontmatter¶

Every document must include:

---
title: Document Title
description: Brief description of the document content
tags:
  - relevant-tag
  - category
---

Code Documentation¶

Use special comments for code visibility:

# BRAINSAIT: Feature description
# MEDICAL: Healthcare compliance note
# NEURAL: AI/ML implementation detail
# AGENT: Agent-specific behavior

Writing Guidelines¶

Tone & Voice¶

• Professional but accessible
• Technical accuracy prioritized
• Active voice preferred
• Clear and concise

Common Terms¶

Use consistent terminology across all documentation:

File Organization¶

Directory Structure¶

docs/
├── index.md              # Main landing page
├── healthcare/           # Volume 1: Healthcare
│   ├── index.md
│   ├── overview/
│   ├── agents/
│   └── sop/
├── business/             # Volume 2: Business
│   ├── index.md
│   ├── strategy/
│   └── marketing/
├── tech/                 # Volume 3: Tech
│   ├── index.md
│   ├── infrastructure/
│   └── apps/
├── personal/             # Volume 4: Personal Dev
│   └── index.md
├── brand/                # Brand & Templates
│   ├── index.md
│   └── templates/
└── appendices/           # Reference materials
    └── glossary_master.md

Naming Conventions¶

Version Control¶

Commit Messages¶

Use this format for documentation commits:

docs: [action] [component] - [brief description]

Examples:
docs: add ClaimLinc agent documentation
docs: update healthcare glossary terms
docs: fix translation in SOP template

Branch Strategy¶

• main - Production documentation
• docs/* - Documentation updates
• feature/* - New features requiring docs

Quality Checklist¶

Before submitting documentation, verify:

• YAML frontmatter is complete
• Content is available in both languages
• Code examples are tested
• Links are valid
• Images have alt text
• Spell check passed
• Technical review completed

Quick Links¶

• Healthcare Documentation
• Tech Documentation
• Master Glossary

BrainSAIT Brand & Templates

OID: 1.3.6.1.4.1.61026