Документирование приложения доступа для разработчиков [Закрыто

Question

Мне нужно документировать приложение MS-Access, которое было создано, разработанное и поддерживаемое полным пользователем мощью в течение 10 лет.

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

Для этого небольшого проекта есть несколько вопросов:

• Что такое хорошая ручная конструкция, создающая приложение? Microsoft Word не совсем разрезает.
• Какие вещи вы, разработчик, должны знать, чтобы внести изменения в такие вещи, как формы, отчеты, таблицы или другие объекты доступа?
• Что-нибудь еще, что я пропустил? Любые подводные камни?

Answer 1

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

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

Answer 2

Вы можете начать с создания некоторой автоматической документации кода, используя Add-In MZ-Tools для VBA. То же самое дополнение может помочь вам очистить неиспользуемые переменные объявления, генерируйте номера строк, переупорядочить процедуры в модуле и т. Д.

Документированные формы сложнее. Мое предложение было бы сохранить съемку экрана, в целом с помощью файла .txt, полученный через недокументированный приложение. Способ.

Answer 3

Я знаю, что это закрыто надолго, но я не могу воздерживаться, добавляя мои 2 цента:
В случае упомянутого случая, я думаю, что наиболее полезный документ для производства является функциональной документацией (которая должна была существовать до начала разработки в идеальном мире).
Во-вторых, в самом коде, и это включает в себя VBA, но и описания поля, которые могут быть установлены в Access и SQL Server.
Третий - это (или набор) приятной диаграммы базы данных. Как только у вас есть, все остальные могут быть созданы новым разработчиком, используя его любимые инструменты.
Говоря о инструментах, мне особенно нравится и рекомендую:

• MZ Tools: Специально легко найти, какие процедуры называют ваш взгляд на
• Smart Chance: правильно подписать код. Пытаясь прочитать плохо с отступом кода делает меня больным
• SQLSPEC: (не Free) генерирует HTML Doc о самой базе данных для большинства двигателей базы данных

Answer 4

Вы пробовали использовать встроенный документальный документ баз данных? Он распечатает все таблицы, индексы, формы, элементы управления, каждое свойство элементов управления. Код, SQL используется и практически в любом другом. Это приводит к огромным, но просто массивные распечатки. Однако, пока он убьет несколько деревьев в процессе, он уверен, что это отличный способ произвести впечатление на босс.