===== AGL Documentation Site Improvements =====

This page is used to capture use cases and idea for documentation site improvments. The AGL documentation site can be found at http://docs.automotivelinux.org/

==== Use Cases ===

  - New application developer who wants to develop a demo AGL application. Should be able to download the SDK, find a sample application, and download the sample application to supported AGL hardware. 
  - App developer wants to learn what APIs are available for a new app she is developing. She wants to browse the AGL service APIs from her web browser. 
  - Board manufacturer wants to learn how to add his BSP to AGL. 
  - BSP developer wants to update his BSP.
  - Platform developer wants to learn how to create a new service binding for AGL.
    - When a new service binding API is created the service should appear on the doc site. 
    - When a service binding API is updated it should automatically update on the doc site.
  - Platform developer wants to learn how to debug her new AGL service binding. 
  - Device creator wants to learn how to take AGL and create a device based on AGL platform software. 
  - As new releases are made of the AGL UCB, older versions of the documentation are available for developers using those older releases. 
  - Re-use test cases from AGL CIAT in a local environment. 
  - As an AGL developer I want to write re-usable automated test cases for new code. 

==== Architecture and Design ====

The site was reviewed by Scott's Documentation Services. Here is their {{:agl-distro:scottys_doc_services_agl_milestone_1-2.pdf|review and proposal for updates}}.