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