23:59
О документации
Аморфный пост разрозненных мыслей.
При разработке железок, т.е. электронно-механических штуковин, документация важнее, чем при разработке программ. По тексту программы можно понять, как она работает (хотя это зависит от сексуальных предпочтений программиста). Железка же, если сравнивать её с программой, представляет собой уже скомпилированный исполняемый файл. Кое-что можно понять по виду, кое-что проверить, но полноценное разбирательство очень трудоёмко и связано, как правило, с разделением железки на составные части.
***
И во время разработки, и во время эксплуатации часть документации может меняться. Возникают новые версии разводок кабелей, принципиальных схем и т.п. С этим связаны два момента.
1. Надо как-то фиксировать, какой версии документации соответствует конкретный экземпляр девайса. При этом у разных частей девайса документация может быть разной версии. Надёжнее всего фиксировать на самих частях. На платах номер ревизии выбивают шелкографией -- я видел. Или можно фломастером точки рисовать, лол.
2. Между версиями может возникнуть путаница. Какая самая новая? Я при создании новой версии на всех обнаруженных экземплярах старой версии надписываю "устарело". Но... что, если кто-то наткнётся на ненайденный экземпляр? А лучше -- на фотографию найденного. В общем, устаревшие версии следует оставлять только в случае, если есть хотя бы один экземпляр устройства, для которого эта документация актуальна. В противном случае устаревшую документацию надо уничтожать или хотя бы прятать подальше в архив.
***
По тексту выше может сложиться впечатление, что я разводки кабелей на бумажке рисую. Так и есть (но не всегда). Однако документация в единственном экземпляре -- это ОЧЕНЬ плохая идея. Поэтому после того, как я нарисовал разводку, я её обязательно фотографирую. Также на бумажке я указываю метаданные: дата, версия и наименование того, что рисую.
При разработке железок, т.е. электронно-механических штуковин, документация важнее, чем при разработке программ. По тексту программы можно понять, как она работает (хотя это зависит от сексуальных предпочтений программиста). Железка же, если сравнивать её с программой, представляет собой уже скомпилированный исполняемый файл. Кое-что можно понять по виду, кое-что проверить, но полноценное разбирательство очень трудоёмко и связано, как правило, с разделением железки на составные части.
***
И во время разработки, и во время эксплуатации часть документации может меняться. Возникают новые версии разводок кабелей, принципиальных схем и т.п. С этим связаны два момента.
1. Надо как-то фиксировать, какой версии документации соответствует конкретный экземпляр девайса. При этом у разных частей девайса документация может быть разной версии. Надёжнее всего фиксировать на самих частях. На платах номер ревизии выбивают шелкографией -- я видел. Или можно фломастером точки рисовать, лол.
2. Между версиями может возникнуть путаница. Какая самая новая? Я при создании новой версии на всех обнаруженных экземплярах старой версии надписываю "устарело". Но... что, если кто-то наткнётся на ненайденный экземпляр? А лучше -- на фотографию найденного. В общем, устаревшие версии следует оставлять только в случае, если есть хотя бы один экземпляр устройства, для которого эта документация актуальна. В противном случае устаревшую документацию надо уничтожать или хотя бы прятать подальше в архив.
***
По тексту выше может сложиться впечатление, что я разводки кабелей на бумажке рисую. Так и есть (но не всегда). Однако документация в единственном экземпляре -- это ОЧЕНЬ плохая идея. Поэтому после того, как я нарисовал разводку, я её обязательно фотографирую. Также на бумажке я указываю метаданные: дата, версия и наименование того, что рисую.
28.03.2019 в 10:10
28.03.2019 в 14:49