Documentation
GenGuard is being developed with documentation as a core part of the platform.
The documentation center will provide operational guidance for users,
administrative procedures for site managers, and detailed engineering references
for authorized technical personnel.
Documentation Library
User Guide
The User Guide explains how to navigate the GenGuard interface,
review site status, monitor live telemetry, interpret alarms,
view maintenance reminders, review exercise schedules, and generate reports.
In Development
Administrator Guide
The Administrator Guide covers user accounts, access roles, site configuration,
device setup, polling groups, backup and recovery, application settings,
and routine administrative tasks.
In Development
Installation Guide
The Installation Guide documents supported server platforms,
Apache and PHP requirements, MariaDB configuration, application deployment,
poller installation, control-service installation, and initial site setup.
In Development
Engineering Reference Manual
The Engineering Reference Manual is the technical source of truth for GenGuard.
It documents architecture, database design, Modbus communications, register definitions,
polling behavior, control requests, maintenance logic, scheduling, reporting,
backup structure, recovery procedures, and troubleshooting.
Authorized Access
Developer Guide
The Developer Guide is intended for authorized developers and technical maintainers.
It will describe the source-code structure, coding conventions, database migrations,
service architecture, page structure, release process, testing, and future extension points.
Authorized Access
Release Notes
Release Notes will document new features, improvements, corrections,
database changes, compatibility notes, and known limitations for each GenGuard release.
Coming Soon
Knowledge Base
The Knowledge Base will provide focused articles for configuration,
troubleshooting, controller compatibility, maintenance workflows,
reporting, backup recovery, and commonly requested procedures.
Planned
Access and Security
Public documentation will include product overviews, selected user guidance,
release notes, and sample reports. Engineering references, internal architecture,
source documentation, register maps, and protected downloads will require
authorized access.
Documentation Goals
- Provide clear operating instructions for end users.
- Preserve engineering knowledge for future technicians.
- Document installation and disaster-recovery procedures.
- Maintain a technical record of supported controllers and registers.
- Keep product documentation aligned with software development.