Как составить перечень файлов электронного проекта

Перечень файлов электронного проекта должен показывать назначение каждого документа и его ревизию. Читателю нужно найти актуальную схему, состав и журнал проверки без угадывания по датам. Файлы разных состояний храните с явными обозначениями.

Учебный пример

Учебная папка r2 содержит README.md с описанием r2, diagram-r2.svg со схемой, parts-r2.csv с перечнем и test-r2.csv с журналом r2. Материалы r1 лежат отдельно. Здесь перечислены назначения файлов; электрические параметры и содержание схемы в упражнении не проверяются.

Порядок действий

Создайте таблицу «файл, назначение, ревизия, связан с, проверка открытия». Для README укажите, что он направляет к остальным документам. Для схемы и перечня запишите одну ревизию и понятные взаимные обозначения. Не добавляйте в manifest файл, который существует только в плане.

Проверьте имена посимвольно. Один лишний дефис или другая редакция в ссылке могут отправить читателя к иному материалу. Если нужный формат требует определённой программы, сообщите это только после фактической проверки в своей среде.

Проверка готового результата

Откройте каждую заявленную позицию и убедитесь, что она относится к указанному состоянию проекта. В контрольной копии проследуйте по ссылкам из README. Зафиксируйте отсутствующее и не называйте комплект полным до устранения пробелов.

Для новой ревизии обновите перечень вместе с затронутыми документами. Наличие test-r2.csv само по себе не доказывает, что проверки проведены или достаточны: их содержание сверяется отдельно. Manifest подтверждает состав передаваемой папки, а не работоспособность устройства.