Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

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" examplesDocumentation will reside in Confluence, and will be able to include videos/gifs/diagrams/etc. for better user understanding

Table of Contents
minLevel1
maxLevel6
outlinefalse
typelist
printablefalse

...

  • Value proposition

  • Target use case (High-level)

  • Visual guide/demo (GIFs, videos)

...

  • 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

...

  • Camera

  • Calibration

...

Installation

  • Safety Precautions

  • Cameras

    • general considerations for camera positioning?

Software Installation

  • Licensing?

  • How to install

  • How to update/uninstall

System Setup

  • Calibration

User Guide

Get started

  • User workflow

    • Start a project

    • Alignment?

    • currently required user input to run: calibration files and aruco transform

RapidSense HMI

  • Layout description

...

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

...