Skip to content

Clients

Per-client implementation documentation — requirements, design, customizations, testing, deployment, and support.

Purpose

Each client engagement gets its own folder with a standardized structure. This ensures consistency across implementations and makes it easy to onboard new team members to a project, consult historical implementations, and (in the future) query client knowledge via AI.

How to Start a New Client

  1. Copy the _template/ folder: cp -r _template/ [client-name]/
  2. Use kebab-case for the folder name (e.g., green-valley-school/)
  3. Fill in overview.md immediately with client profile and scope.
  4. Populate other sections as the project progresses.

See PROJECT_INSTRUCTIONS.md — Client Documentation Rules for full details.

Client Index

Client Solutions Status Folder
Saint Edwards ARM Active saint-edwards/
Al Faisal ARM Active al-faisal/
Pymble ARM Active pymble/

Folder Structure Per Client

[client-name]/
├── overview.md                    ← Client profile, scope, timeline
├── requirements/
│   ├── business-requirements.md   ← Business requirements
│   └── technical-requirements.md  ← Technical requirements
├── design/
│   ├── solution-design.md         ← How solutions are configured
│   ├── integrations.md            ← SIS, payment gateways, other systems
│   └── data-migration.md          ← Data migration plan
├── customizations/
│   ├── scripts.md                 ← SuiteScript customizations
│   ├── workflows.md               ← NetSuite workflow customizations
│   ├── forms-records.md           ← Custom forms, fields, records
│   └── reports.md                 ← Custom reports & saved searches
├── testing/
│   └── test-cases.md              ← Test scenarios and results
├── deployment/
│   └── go-live-checklist.md       ← Go-live readiness checklist
└── support/
    └── known-issues.md            ← Post go-live known issues

Confidentiality Reminder

⚠️ Never include passwords, API keys, PII, or financial contract terms in client documentation. See PROJECT_INSTRUCTIONS.md for full confidentiality rules.