System Page Template (Business-User First)
Use this template for every system page in ../systems/.
Writing Intent
- Explain the system in plain business language first.
- Add technical details only when they improve decision-making.
- Always connect capability to measurable business value.
Required Page Structure
Copy this section and replace placeholders.
# <System Name> ## 1) What This System Is Briefly define the system in one or two paragraphs. ## 2) Who Uses It - Primary business users - Secondary users (admins, operations, IT) ## 3) Business Problem It Solves - Problem A - Problem B - Problem C ## 4) Core Capabilities ### Capability 1 What it does and why that matters for the business. ### Capability 2 What it does and why that matters for the business. ## 5) Major Benefits and Advantages - Benefit 1 (outcome and impact) - Benefit 2 (outcome and impact) - Benefit 3 (outcome and impact) ## 6) Typical Business Scenarios ### Scenario: <Scenario Name> - Trigger - Workflow - Expected outcome ## 7) Dependencies and Related Systems - Upstream and downstream systems - External services (if relevant) - Critical operational dependencies ## 8) Success Indicators - Adoption metrics - Productivity metrics - Quality/risk metrics ## Source Evidence - Path: <repo/file/path> - Path: <repo/file/path> ## Related Documentation - Link 1 - Link 2
Quality Checklist (Must Pass)
- The page can be understood by a non-technical business user.
- Every capability is linked to a business outcome.
- "Benefits and Advantages" section is explicit and substantive.
- Dependencies are clearly named and cross-linked.
- At least three practical scenarios or scenario variants are included.
- Source evidence paths are included and relevant.
Style Rules
- Use concise headings and short paragraphs.
- Prefer active voice and direct wording.
- Avoid unexplained acronyms; define terms on first use.
- Use tables when comparing options or roles.
- Keep claims evidence-based and avoid marketing-only statements.