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

10.06.2009, 18:03. **Показов** 10313. **Ответов** 3

Студворк — интернет-сервис помощи студентам

Требуется сделать описание элементов дизайна (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. Описание необходимо для заказчика, по этому необходимо иметь отдельно от самого кода хорошую документацию продукта. Спасибо.

@okupoko · 10.06.2009, 18:29

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

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

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

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

10.06.2009, 18:44

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

@turumboy · 14.06.2009, 12:34

Сообщение от DevLotus

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

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

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

Лучшее решение без сомнения есть
http://www.lsdoc.org/webcm/lsd... doc_syntax

Новые блоги и статьи Все статьи Все блоги /
Сумматор с применением элементов трёх состояний. Hrethgir 26.03.2026 Тут. https:/ / fips. ru/ EGD/ ab3c85c8-836d-4866-871b-c2f0c5d77fbc Первый документ красиво выглядит, но без схемы. Это конечно не даёт никаких плюсов автору, но тем не менее. . . всё может быть. . .	Автозаполнение реквизитов при создании документа Maks 26.03.2026 Код из решения ниже размещается в модуле объекта документа, в процедуре "ПриСозданииНаСервере". Алгоритм проверки заполнения реализован для исключения перезаписи значения реквизита, которое может. . .	Команды "Заполнить" и "Очистить" на форме документа Maks 26.03.2026 1. Команда формы "ЗаполнитьЗапчасти". На примере нетипового документа разработанного в конфигурации КА2. В качестве источника данных указан регистр накопления, в который записываются данные о. . .	Кому нужен AOT? DevAlt 26.03.2026 Решил сделать простой ланчер Написал заготовку: dotnet new console --aot -o UrlHandler var items = args. Split(":"); var tag = items; var id = items; var executable = args;. . .
Отправка уведомления на почту при изменении наименования справочника Maks 24.03.2026 Программная отправка письма электронной почты на примере изменения наименования типового справочника "Склады" в конфигурации БП3. Перед реализацией необходимо выполнить настройку системной учетной. . .	модель ЗдравоСохранения 5. Меньше увольнений- больше дохода! anaschu 24.03.2026 Теперь система здравосохранения уменьшает количество увольнений. 9TO2GP2bpX4 a42b81fb172ffc12ca589c7898261ccb/ https:/ / rutube. ru/ video/ a42b81fb172ffc12ca589c7898261ccb/ Слева синяя линия -. . .	Midnight Chicago Blues kumehtar 24.03.2026 Такой Midnight Chicago Blues, знаешь?. . Когда вечерние улицы становятся ночными, а ты не можешь уснуть. Ты идёшь в любимый старый бар, и бармен наливает тебе виски. Ты смотришь на пролетающие. . .	SDL3 для Desktop (MinGW): Вывод текста со шрифтом TTF с помощью библиотеки SDL3_ttf на Си и C++ 8Observer8 24.03.2026 Содержание блога Финальные проекты на Си и на C++: finish-text-sdl3-c. zip finish-text-sdl3-cpp. zip

Dyvtotus

	Требуется сделать описание элементов дизайна 10.06.2009, 18:03. Показов 10313. Ответов 3 Метки нет (Все метки) Требуется сделать описание элементов дизайна (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. Описание необходимо для заказчика, по этому необходимо иметь отдельно от самого кода хорошую документацию продукта. Спасибо.

@okupoko 0 / 0 / 0 Регистрация: 04.10.2007 Сообщений: 2,977
	10.06.2009, 18:29
	(размышления) ну... ты видел в справке для пользователя описание форм или других элементов дизайна?.. в UTD стоит разместить лишь информацию о том, как с этой базой работать, без упоминания каких-либо элементов дизайна... всю справочную инфу юзера можно положить в UTD, а можно создать отдельную базу (как стандартная справка), можно даже сделать ее контекстной (в справке см как), а в UTD лишь краткое описание оставить или сделать посыл на справучную БД... там же необходимо описать как правильно настраивать базу для работы, т.е. как настроить ACL для разных пользователей по ролям. если нужна техническая документация по приложению, то ее следует вести отдельно от пользовательской. как именно ты ее будешь вести - это уже выбирать тебе или заказчику. вообще, я думаю, что в виде домино БД она будет смотреться куда привычнее... вот чем автоматизировать процесс создания и ведения документации, это вопрос, я не подскажу, разве что самому написать какую-то фигню... посмотри утилиты TeamStudio, возможно существует нужная для тебя тулза. еще есть стандартная Database Synopsys. еще можно дизайн выгрузить в DXL (XML) и делай с ним, что хош. рытье базы с помощью Notes C API советовать, наверное, не буду... 0

Dyvtotus
	10.06.2009, 18:44
	Спасибо, буду думать.