Operations documentation
Welcome to Ethica Capital operations documentation. These guides explain how to use our web applications in plain language—no technical jargon. They are suitable for staff, and in places noted below, for customers or applicants.
Documentation layers on this site
| Layer | Where to read | Purpose |
|---|---|---|
| Operations (this section) | Operations home | How to use the products: staff guides, customer-facing basics, workflows. |
| Architecture | Architecture | System design and diagrams. |
| Technical | Technical | APIs, database, auth, engineering reference. |
| Runbooks | Runbooks | Deployment, rollback, monitoring, and incident response. |
What belongs in operations
- How to use each major area of the staff system (customers, investments, finance, people, system tools).
- How customers use the client portal and how applicants use onboarding.
- End-to-end workflows at a business level (who does what, in which application).
- Roles and permissions explained in plain terms (for example, who can approve an investment or manage the chart of accounts).
What does not belong here
- Source code, database tables, API paths, or infrastructure names.
- Secrets, credentials, or detailed security mechanisms.
- Deep technical architecture (see Architecture and Technical).
Tone and style
- Write like a training manual or internal wiki: short sections, clear steps, consistent terms for screens and actions.
- Prefer “you” for the reader when giving instructions.
- If a business rule is undecided or may change, say so briefly or add a short Open questions section rather than guessing.
Keeping this up to date
Documentation goes stale quickly if it is only written once. When your team ships a visible change to a process or screen, update the relevant page here in the same delivery cycle, or add a dated note at the top of the file until someone can refresh it.