Документация

Для того чтобы спроектировать простое мехатронное устройство, необходимо составить проект механику, электронику и датчики, системы управления и программное обеспечение для данного устройства. В конце проекта составляется отчет, который должна состоять, по крайней мере, из следующего:

• Титульный лист
• Резюме
• Резюме(на иностранном языке)
• Содержание
  1. Исходное задание
  2. Tребования и ограничения к системе
  3. Общая модель системы
     Модели структуры системы и функциональности блок-схемами. Дополнительно можно составить диаграмму прецедентов, интерфейсов и других.
  4. Проектные решения
     Как минимум три различных концептуальных решения, как решить данное задание. Подходят отсканированные нарисованные от руки схемы, наброски и другая документация вместе с комментариями.
  5. Механика
     Желательно 3D модель с рабочими рисунками и указаниями к сборке важных узловых соединений. Если какой-либо узел требует особых указаний для сборки, то и сборочный чертёж с инструкциями, при возможности анимацию о работе системы.
  6. Электроника
     Общая блок-схема, где показаны используемые модули (контроллер, электропривод, двигатель, кодер и др. и их соединения). При возможности стандартная схема электроники и монтажная схема печатной платы.
  7. Управление
     Алгоритм управления и начальный код. Если использованы самодельные функции, то и таблица функций и параметров, таблица приоритетов прерываний и т.д.
  8. Готовое решение
     Описание и изображения
  9. Финансовые подсчёты
     Список компонентов вместе со стоимостью, калькуляция рабочего времени и т.д.
  10. Управление проектом
      График проекта, распределение ресурсов, разделение труда, вклад членов команды, протоколы собраний и т.д.
  11. Резюме и выводы
      Что оказалось сложным, что было бы сделано по-другому, чему новому научил проект и т.д. В резюме кратко описывается проделанная работа, возникшие проблемы и результат. Так же неплохо добавить в резюме своё мнение об актуальности проекта, о пользе его для участников, о том, что в будущем можно сделать по-другому, чему научились и что бы посоветовали руководителю и организатору проекта.
• Ссылки и использованный материал
• Приложения

Следующий пример проекта является образцом того, как составить документацию и отчет по проекту. К сожалению, отчёт предоставлен в сокращенном виде из-за ограниченного объема данной книги, но направлен на демонстрацию различных аспектов документации.