Documentation

Enertics Documentation

 

The purpose of documentation is to enable the internal users of the organization to understand the operational aspects of their respective work areas. The entire manual has been categorized based on the departments in the organization.
The following hierarchy has been defined by Enertics Management:

  1. Development Department
    • Overview
      1. Brief Summary
      2. Process Flow
      3. High-level Diagram
    • Hardware
      1. Devices
      2. Architecture
      3. Composition
      4. Device version management
      5. Releases
    • Software
      1. Solutions
      2. Architecture
      3. Process
        • User Manual ✔
      4. Methodology
      5. Product
        • User Interface ✔
    • Firmware
      1. Firmware Consideration
      2. Development Set
      3. IDE and programming language
      4. Methodology
      5. Releases
    • Servers
      1. Cloud
        • Instance creation with dependencies
      2. On-premises (VMware installation)
        • Solution requirements
        • Server selection criteria
        • Server Configuration
        • Solution installation and deployment
        • Testing
        • QA
        • Security considerations
      3. DevOps/AWS
        • Jenkins Setup ✔
        • Front End Deployment ✔
        • Backend Deployment (CI/CD Pipeline) ✔
        • Setup Email Alerts ✔
      4. Production
        • Data capturing and saving ✔
    • QA Testing
      1. Firmware Testing
      2. Software Testing ✔
    • Maintenance