Internal Note: Here is how we create the manual.
First focus on getting internal documentation refined and organized
Create a skeleton of what the manual would be to start working off of
User manual will pull information from internal documentation, but also include things for user workflow, including things like hardware requirements, disclaimers, and "happy path" examples
Introduction
Overview
What is RapidSense
Value proposition
Target use case (High-level)
Visual guide/demo (GIFs, videos)
System Architecture and Requirements
System diagram
Relationship with RapidPlan(Create & Control)
incl. references to the manuals
System requirements
Supported vision sensors
vrd definition
PC spec and OS requirements
Setup
Hardware Installation
Safety Precautions
Cameras
general considerations for camera positioning?
Software Installation
Licensing?
How to install
How to update/uninstall
System Setup
Calibration
Configuration
User Guide
Get started
(Happy path of a user workflow)
Start a project
Alignment?
currently required user input to run: calibration files and aruco transform
RapidSense HMI
Layout description
Features
RapidSense Filters
How to apply the different filters with their API and what they can do
Integration with Other Systems
API Documentation
Maintenance/ Repair
Troubleshooting and Support
FAQ
Common Problems and Solutions
Contact Information
Legal and Compliance
Licensing Agreement
Privacy Policy
Appendices
Glossary
Release Notes