Архив на программное обеспечение.
Общая идея. Архив должен содержать такую информацию, которая понизит порог входа для специалиста, работающим с этим программным обеспечением. Другими словами, архив, помимо программы, должен содержать ответы на вопросы, возникающие в первую очередь
В архиве должна быть полностью протестированная программа!!! Если в программа не тестировалась по объективным причинам после последних изменений, в сопровождающем файле должно быть написано "программа не протестирована". Или "после внесения таких-то изменений программа не тестировалась".
Исходный код. В исходном коде должно быть разумное количество комментариев.
Исполняемые файлы в отдельных каталогах, не связанных со средой проектирования и исходным кодом, чтобы не было такой ситуации, что при компиляции старые исполняемые файлы стёрлись, а новые из-за ошибок не создались
В каталоге, где хранятся исполняемые файлы, должно храниться описание отличий одной реализации от другой (или особенностей), если их несколько .
Описание особенностей алгоритма. Если есть несколько вариантов исходного кода, то должны быть описания отличий одной реализации от другой (или особенностей). Даже если описания совпадают с п. 3, они должны быть продублированы: одно хранится в каталоге с исполняемыми файлами, а другое – в документации на программу. В описании алгоритма не нужно описывать что делает каждый оператор (операторы языка программирования и так являются словами английского языка). Надо описывать на один или несколько уровней выше - то, что не очевидно из текста программы. В первую очередь надо написать, для чего написана данная функция или структура данных с точки зрения выполнения основных функций алгоритма. Во вторую очередь можно комментировать не очевидные приёмы программирования. В третью очередь - комментировать настройки железа микроконтроллера.
Описание интерфейса с внешними устройствами, если такой есть.
Описание процесса компилирования в той среде, в которой разработано программное обеспечение (коротко)
Инструкция по программированию процессора, включая версии программы для записи во FLASH, ссылку на программатор в международном интернет-магазине.
Краткое описание, как тестировалась программа.
Схема и BOM (по Digikey или другим международным магазинам) для адаптера или кабеля программирования, если такой изготавливался.
Также среда программирования, программа для записи во Flash должны быть установлены на компьютере в лаборатории, должны быть продемонстрированы менеджеру проекта или лицу, им указанному, процесс компиляции и программирования. В лаборатории должны остаться все аппаратные средства, необходимые для программирования.
Модификация программ. Надо в текстовом файле написать какие были сделаны доработки (кратко на англ для каждой версии программы). Надо написать, какие файлы были изменены, если изменения будут добавляться в другой проект. Для англ языка можно использовать просто перевод Google переводчика.