Пример структуры учебной документации

В качестве примера можно привести документацию на программную составляющую движущейся платформы Rash 1.

Если исходить из концепции разработки роботов, то необходимо отметить, что приведенная документация соответствует по сути только модулю «платформенное ПО» и полностью не отражает механическую составляющую робота, а также серверную и клиентскую составляющие, но приемлимо описывает отдельные моменты схемотехники платформы в виде ТО на отдельные датчики и устройства, которые были созданы в процессе понимания работы этих устройств.

Документация приведена в виде графических файлов. Ниже приведены файлы и папки с пояснениями имеющегося материала в них.

1-Функциональная схема.jpg
Функциональная схема робота с позиции управления.

2-Функциональная схема управления платформой.jpg
Функциональная схема программных модулей.

3-Структурная схема управления платформой.jpg
Структурная схема программных модулей.

ТЗ на программные модули\Модуль интерфейса
Детальное ТЗ на интерфейсный модуль.

ТЗ на программные модули\Модуль определения дальности
Детальное ТЗ на модуль определения дальности.

ТЗ на программные модули\Модуль управления
Детальное ТЗ на модуль управления платформой.

ТЗ на программные модули\Модуль управления двигателей
Детальное ТЗ на модуль управления двигателями.

Описание периферии\Драйвер двигателей
Детальное ТО на драйвер двигателей.

Описание периферии\УЗ датчик дальности
Детальное ТО на ультразвуковой датчик расстояния.

Описание периферии\Carduino Nano v7.jpg
ТО на плату управления движущейся платформы.

Программа
Программа для микроконтроллера платы управления движущейся платформы.

Скачать архив.