Обработка бумажной документации [закрыто]

Question

После написания каждой новой программы остается много бумажной документации.

Помимо обычных заметок программистов, обычно есть хорошая куча документов, содержащих объяснения физических моделей, расчеты и так далее (уравнения, таблицы, графики, маленькие картинки, описывающие переменные ...)

Обычно мы выполняем трудоемкие вычисления в консольных приложениях, которые не публикуются для широкой публики (остаются в доме, публикуются только результаты).Перед завершением каждого проекта все эти документы должны быть каким-то образом упакованы вместе с приложением, чтобы однажды, когда кто-то будет повторно использовать его части, иметь некоторое представление о том, что там к чему.До сих пор мы использовали "грязное" решение, просто сканируя все это и помещая на диск вместе с приложением.

Вот мне и стало интересно ...для всех научных работников , находящихся здесь в аналогичной ситуации ...как вы обращаетесь с проектной документацией, которая необходима, но не обнародована?(тот, который справляется, достается парням из dtp, и они делают его красивым и блестящим - больше не наша проблема :)

Answer 1

Я использую один из трех вариантов:

• Храните все в моих лабораторных тетрадях, которые я сам архивирую, для материалов низкого уровня
• Отсканируйте бумажный документ и добавьте в систему управления версиями в формате pdf.Это некрасиво, но если это кому-то нужно, то оно есть
• Расшифруйте уравнения, результаты и т.д...в чистом формате (обычно Latex) для дальнейшего использования и, опять же, добавьте в систему управления версиями.Официальная бумажная копия подписывается (я работаю в строго регулируемом домене) и помещается в папку.

Answer 2

В проектах, над которыми я работал, мы выполняли много физических вычислений в наших программах, и, следовательно, у нас было много занятий на доске с уравнениями, над которыми мы работали.

Мы ведем wiki-страницу для каждого крупного проекта, и после каждого сеанса работы с доской мы физически фотографируем доску цифровой камерой и загружаем / упорядочиваем ее в wiki.Мы также сканируем бумажные документы из записных книжек разработчиков, если это важно, и также включаем их в wiki.

Затем мы создаем резервную копию wiki на диске для хранения.Таким образом, наше решение очень похоже на ваше, за исключением того, что мы используем project wiki для организации.

Answer 3

Если это важно, мне кажется, вам следует относиться к внутренней документации с той же осторожностью, с какой вы относитесь к общедоступным документам.

Answer 4

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

Answer 5

Вот некоторые из этих мыслей...Хотя это и не так практично :)

1. Мы можем включить это в наши записи о регистрации заезда.Это может помочь разработчикам в обслуживании приложения.
2. Обновите документ требований / низкоуровневый проектный документ с помощью этих элементов