Если бы губы Никанора Ивановича да приставить к носу Ивана Кузьмича…

Последние пост Макса про неаккуратного инженера, который пренебрегает журналом, побудил меня задуматься о моих собственных записях.

Фиксация сведений о ходе разработки, результатов измерений, принятых (и отвергнутых) решений, выполненных расчетов являются частью любой инженерной работы. В каждом проекте есть много аспектов, подлежащих документированию, а проекты с применением контроллеров и / или программируемой логики, содержат еще и программную часть, вплоть до объектного кода (чтобы потом не пытаться мучительно вспомнить, а под какой средой этот проект компилировался и почему теперь перестал). Причины, по которым мы должны вести записи, включают в себя (но не ограничиваются):
Подтверждение разработки,
Получение данных для использования в паспортах,
Определение подходов для тестирования устройства,
Патенты,
Юридическая ответственность,
Бухгалтерский учет и аудит (для налоговых кредитов или промежуточных выплат),
Аудит ISO.

В настоящий момент я использую документирование в стиле 20 века — все на бумаге. У меня есть папка для подшивки, в которой я держу требования, спецификации, списки, схемы и другие листки бумаги, а также журнал для заметок (ноутбук). На самом деле мой ноутбук больше похож на журнал для записок. Он содержит рукописные заметки, рисунки и расчеты, вместе с вклеенными страницами, такими, как рабочие листы Excel, фотографии, осцилограммы, описания дизайна и другие. Это все выглядит довольно неуклюже и не слишком удобно в работе, когда пытаешься следовать требованиям аудита ISO.

Приложение, которое я хотел бы иметь, должно повторить дизайн папки для подшивки как единого файла с определенным улучшением. Я хотел бы, чтобы оно было портировано как на ПК, так и на носимые устройства. Конечно, обязательна возможностью ввода текста на клавиатуре и возможность включать MSWord и PDF файлы. Можно было бы также добавить рукописные заметки, предпочтительно с помощью стилуса, так как он работает лучше, чем мой палец. Преобразование рукописного текста в машиночитаемую форму будет значительным плюсом при поиске. Приложение должно иметь возможность добавлять примечания к включенными листам в формате PDF. Оно должно содержать простой табличный процессор, чтобы собрать данные, например, от климатической установки, а затем выполнить несколько простых вычислений. Но оно так же должно иметь возможность интегрировать более сложные расчеты с помощью Excel или даже Matlab, хотя я готов согласиться на скрин-шоты с гиперссылками на соответствующие файлы.

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

Взаимодействие с приборами через DVMS либо что-нибудь типа USB или Wi-Fi, вероятно, нереально в краткосрочной перспективе, хотя было бы неплохо иметь что-то вроде скриптового языка либо языка программирования для настройки на пользователя.

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

Существуют десятки приложений, которые затрагивают отдельные аспекты моего списка пожеланий, но до сих пор я не нашел такого, которое реализовывало бы действительно комплексный подход. В то же время все необходимые технологии уже существуют, и я надеюсь, что этот блог подтолкнет кого-то к созданию такого приложение. Иногда мне кажется, что ноутбук (переносной ПК) отвечает моим требованиям к железу и эко-система Windows, ближе всего к уровню интеграции, который мне нужен, но рукописный ввод крайне важен и формат оболочки часто неудобен. Acecad DigiMemo L2 также имеет неплохой потенциал в качестве устройства ввода, позволяя в полной мере использовать бумагу и перо, но ему не хватает некоторых других особенностей, которые я хотел бы иметь.

Как документировать свои проекты? Знаете ли вы приложение, которое отвечает моим потребностям?

PS. С нетерпением ожидаю минусов, похоже это такая национальная забава — минусовать переводы.

ссылка на оригинал статьи http://habrahabr.ru/post/258597/