1.1 Требование к оформлению.
1.1.1 Все константы, определяющие логику работы, должны быть вынесены в отдельный файл (с комментариями), может несколько отдельных файлов для сложных программ.
1.1.2 Должны быть указаны единицы измерения констант, лучше всего в имени константы. В крайнем случае в комментарии.
1.1.3 Полярность всех дискретных входов/выходов должна задаваться константами (0,1) в (том же ) отдельном файле.
1.1.4 Должны использоваться длинные мнемонические имена.
1.1.5 Должно быть краткое описание для логики функционирования изделия в целом (возможно, дополняющее или уточняющее тех. задание). Кратко (до 1-й печатной страницы) описание структуры и принципов функционирования программы, взаимодействия процедур и режимов аппаратных ресурсов.
1.2 Некоторые специальные требования
1.2.1 Для всех дискретных входов должна быть предусмотрена защита от дребезга.
1.2.2 В процессоре должны быть задействованы минимальные механизмы, повышающие надёжность:
1.2.2.1 WDT
1.2.2.2 Детектор низкого напряжения питания.
1.2.2.3 Проверка контрольной суммы программы.
1.2.2.4 Проверка контрольной суммы запоминаемых данных.
1.2.3 Архив (имя архива это <название проекта>) на программное обеспечение должен содержать следующие файлы:
1.2.3.1 Тех. задание. Файл Word, в корне, имя TZ_<название проекта>
1.2.3.2 Проект - папка с файлами, которые нужны для этого проекта в той среде, в которой проект разрабатывался. В корне, имя папки: PRJ_<название проекта>
1.2.3.3 Исполняемые файлы в отдельных каталогах, не связанных со средой проектирования и исходным кодом, чтобы не было такой ситуации, что при компиляции старые исполняемые файлы стёрлись, а новые из-за ошибок не создались. В папке EXE_<название проекта>
1.2.3.4 В каталоге, где хранятся исполняемые файлы, должно храниться описание отличий одной реализации от другой (или особенностей). В формате имя исполняемого файла: описание. Файл Word, имя EXE_DOC_<название проекта>
1.2.3.5 Описание особенностей алгоритма. Если есть несколько вариантов исходного кода, то должны быть описания отличий одной реализации от другой (или особенностей). Даже если описания совпадают с п. 3, они должны быть продублированы: одно хранится в каталоге с исполняемыми файлами, а другое – в документации на программу. В формате имя проекта: описание. Файл Word, в корне, имя DOC_<название проекта>
1.2.3.6 Описание процесса компилирования в той среде, в которой разработано программное обеспечение, версия IDE, ссылка на неё в интернете (два-три предложения). Файл Word, в корне, имя IDE_<название проекта>.
1.2.3.7 Инструкция по программированию процессора, ссылка на программу для программирования в интернете (два-три предложения). Файл Word, в корне, имя PRG_<название проекта>.