Chaseis4344 / USV-Project-Code

0 stars 0 forks source link

TODO: Document core functions of Auto Planner #2

Closed Jiffy953 closed 9 months ago

Jiffy953 commented 10 months ago

Objective

The primary aim of this task is to conduct a comprehensive analysis and documentation of the main functionalities within the Auto Planner software. This detailed insight is crucial for enabling the effective replication of key features in our web portal’s UI, even before understanding their exact implementations.

Key Responsibilities

  1. Functionality Analysis: Examine the Auto Planner software to identify and understand its core functions. Focus particularly on features that are essential for our project scope.

  2. Feature Documentation: Document each identified function in detail, including:

    • Run Line Configurations: Investigate how run lines are drawn within the software. Detail the various configuration options available and their implications.
    • Polygon Manipulation: Explore the capabilities around polygon handling on the map. This includes creating, editing, and deleting polygons, and understanding if multiple polygons can be managed simultaneously.
    • Additional Features: Note any other significant features that could be relevant for our web portal.
  3. Visual and Written Examples: For each function documented, provide both written explanations and visual examples. These can include screenshots, flow diagrams, or simple sketches to illustrate how each feature works.

  4. UI Element Preparation: Based on the documentation, propose initial designs or concepts for UI elements in our web portal that would support these functionalities. The focus here is on conceptual alignment with the Auto Planner features rather than on detailed technical implementation.

Jiffy953 commented 9 months ago

Finished documentation located here :))