Documentation
AkshaEDU Documentation Standards
This page defines how AkshaEDU documentation should be structured so every feature page explains purpose, fields, valuesets, LOVs, screenshots, actions, validations, and dependencies in the same way.
Documentation authorsFunctional consultantsImplementation teams
Separation rules
- Docs home should contain only common documentation topics and product entry points.
- AkshaERP and AkshaEDU must have separate documentation areas, separate sidebars, and separate product pages.
- Shared platform topics may be referenced from AkshaEDU only as integrations, not as mixed product pages.
Locked documentation hierarchy
AkshaEDU documentation should follow Section > Feature Group > Feature.
The main top-level sections are Setup, Transactions, Analytics, Portals, and Integrations.
Header-only page template
- Feature Title
- Purpose
- Navigation
- Business Purpose
- Prerequisites
- Screen Overview
- Process Flow / When Used
- Screenshots
- Field Reference
- Actions
- Value Sets Used
- LOV / Reference Data
- Status Meanings
- Validations and Business Rules
- Operational Reference
- Example Record
- Related Features
Header + lines page template
- Feature Title
- Purpose
- Navigation
- Business Purpose
- Prerequisites
- Screen Structure
- Process Flow / When Used
- Screenshots
- Header Fields
- Child Tabs Overview
- Child Tab Details
- Actions
- Row Operation Rules
- Date Handling Rules
- Value Sets Used
- LOV / Reference Data Used
- Status Meanings
- Validations and Business Rules
- Operational Reference
- Example Document
- Related Features
Locked field and action table formats
Field Reference Format
UI Label, Technical Field, Type, Mandatory, Value Set / LOV, Default, Description, Validation / Rules, Example.
Action Reference Format
Action, Purpose, Available On, Validation, Outcome.
Value Set Format
Field, Value Set Code, Allowed Values, Notes.
LOV Format
Field, Source Entity, User-visible Label, Stored Value, Notes.
AkshaEDU-specific rules
- Header + lines pages must explain child-tab behavior and row operations using C, E, D, and N.
- Date handling should explicitly state DD-MM-YYYY on the screen and YYYY-MM-DD when saved.
- Valueset fields should list the EDU_ value-set code and allowed values.
- LOV fields should identify the source entity, the user-visible label, the stored value, and any important usage notes.