Skip to content

Documentation Standard

This standard defines the required structure for future Rxilient documentation modules. It applies to HCO, HCP, Activity, Finance, CRM, SFE, Supply Chain, Due Diligence, Reimbursement, and Activity Management documentation.

File Structure

Each module should use a folder-based structure under the relevant documentation area:

docs/
user-manual/
module-name/
├── overview.md
├── process-page.md
├── role-or-feature-page.md
└── faq.md

Avoid placing a full module in one large document. Split content by business process, role, or user task.

Front Matter

Every page must include front matter:

---
title: Page Title
module: Module Name
version: 1.0
---

Mandatory Page Sections

Each module should include the following documentation elements.

1. Overview

Summarize what the module does, who uses it, and where it sits in the business process.

2. Business Purpose

Explain why the process exists, what business outcome it supports, and which governance or operational needs it addresses.

3. User Roles

List the roles that interact with the module and describe each role's responsibility.

Role Responsibility
Requester Creates and maintains records.
Approver Reviews and approves workflow actions.
Administrator Maintains configuration and access.

4. Process Flow

Document the main lifecycle and key status transitions. Use Mermaid diagrams for workflows where helpful.

flowchart TD
    A[Create Record]
    B[Approval]
    C[Execution]
    D[Completion]
    A --> B
    B --> C
    C --> D

5. Field Description

Describe important fields in table format.

Field Description Required Notes
Record Name Business identifier for the record. Yes Use clear naming.

6. Permission Rules

Document who can create, view, edit, approve, reject, export, or delete records. Include workflow-specific restrictions and post-approval edit rules.

7. FAQ

Capture common user questions, exceptions, and business clarifications.

Image Management

Images should be stored by module:

docs/assets/module-name/

Reference images using relative paths from the Markdown page:

![Screen Name](../../assets/module-name/screen-name.png)

Use descriptive lowercase filenames with hyphens.

Content Guidelines

  • Write for business users first.
  • Keep each page focused on one process or feature.
  • Prefer tables for fields, roles, statuses, and permission matrices.
  • Use admonitions for warnings, compliance notes, and important process reminders.
  • Keep screenshots close to the step they explain.
  • Validate internal links during mkdocs build.

Note

Future AI knowledge base integration will work best when headings, page scope, field tables, and process diagrams are consistent across modules.