Требуется сделать описание элементов дизайна

[DevLotus]

Требуется сделать описание элементов дизайна (Forms/SubForms/View/Script Libraries и т.д.). Для каждой библиотеки и включенных в нее функций необходимо сделать краткое их описание, описание входных и выходных параметров.

Любая база данных под Lotus Notes может содержать два необязательных типа справочных файлов: Using This Database (описывает применение базы в общем) и About This Database (кратко описывает общее представление о базе данных).

Несколько соображений о содержимом Using This Database:
- кратко познакомить с базой читателя;
- описать входящие в базу формы;
- перечислить группы доступа;
- рассмотреть всевозможные роли;
- перечислить администраторов базы данных.

НО! Мне необходима более полная документация - толковое описание всех функций написаных библиотек. Возможно кто то уже для себя как то делал документацию по БД Лотуса, что посоветуете?
Мои соображения на эту тему:
- делать отдельно *.doc/pdf/chm файлы справки, описать все то необходимо и подкрепить их к Using This Database;
- создать отдельно БД (наподобие БД 'Lotus Notes 7 Help') и полностью описывать ВСЕ созданные БД в ней.

Возможно есть и какое-то лучшее решение.

P.S. Описание необходимо для заказчика, по этому необходимо иметь отдельно от самого кода хорошую документацию продукта. Спасибо.

 

[Akupaka]

(размышления)
ну... ты видел в справке для пользователя описание форм или других элементов дизайна?..
в UTD стоит разместить лишь информацию о том, как с этой базой работать, без упоминания каких-либо элементов дизайна...
всю справочную инфу юзера можно положить в UTD, а можно создать отдельную базу (как стандартная справка), можно даже сделать ее контекстной (в справке см как), а в UTD лишь краткое описание оставить или сделать посыл на справучную БД...
там же необходимо описать как правильно настраивать базу для работы, т.е. как настроить ACL для разных пользователей по ролям.

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

вот чем автоматизировать процесс создания и ведения документации, это вопрос, я не подскажу, разве что самому написать какую-то фигню...

посмотри утилиты TeamStudio, возможно существует нужная для тебя тулза.
еще есть стандартная Database Synopsis.
еще можно дизайн выгрузить в DXL (XML) и делай с ним, что хош.
рытье базы с помощью Notes C API советовать, наверное, не буду...

 

[DevLotus]

Спасибо, буду думать.

 

[turumbay]

НО! Мне необходима более полная документация - толковое описание всех функций написаных библиотек. Возможно кто то уже для себя как то делал документацию по БД Лотуса, что посоветуете?
Мои соображения на эту тему:
- делать отдельно *.doc/pdf/chm файлы справки, описать все то необходимо и подкрепить их к Using This Database;
- создать отдельно БД (наподобие БД 'Lotus Notes 7 Help') и полностью описывать ВСЕ созданные БД в ней.

Возможно есть и какое-то лучшее решение.

P.S. Описание необходимо для заказчика, по этому необходимо иметь отдельно от самого кода хорошую документацию продукта. Спасибо.

Лучшее решение без сомнения есть

Ссылка скрыта от гостей