руководства для клиент-серверного ПО
- Войдите на сайт для отправки комментариев
Пишу документацию к сервер-клиентскому ПО согласно ГОСТ 19. Сразу 3 вопроса.
1. Учитывая что клиентом и сервером будут пользоваться разные люди, разумно ли и возможно ли вообще поступить следующим образом:
Руководство системного программиста (админа) - писать в основном по серверной части, а руководство оператора - только по клиентской части?
2. Если да, то можно ли в руководство админа включить разделы по операциям с клиентской частью(!), выполнение которых входит в обязанности админа.
3. Насколько я понял из гостов, требования ГОСТ по руководствам заточены под конкретный функционал (создать файл, изменить файл, подключитбся к источнику данных...), но не учитывают особенности интерфейса. Как лучше всего подать данные по интерфейсу - включить приложением в руководства или включить в другой документ?
4. А зачем?
5. Не вижу криминала. Сначала на железо ставится ОС, поверх ОС ставится сервер, если его нет, или "поднимается", если есть в составе ОС. Ставим убунту, к примеру, поднимаем апач (или устанавливаем поверх убунту нджинкс, если его нет в дистрибутиве), потом прикручиваем апи и плагины. Стандартные операции, можно все слить в руководство администратора.
вопросы тогда такие:
4. клиент-серверное ПО включает в себя две части. Подходить к нему как к комплексу?
5. на деле, ситуация еще сложнее - сервер устанавливается поверх другого софта + АПИ + подключение плагинов по протоколам. Допустимо ли объединить все это в одном руководстве администратора?
Зависит от специфики софта. Серверная часть может требовать не только наличия админа, но и иного лица-пользователя. Если брать за основу свежий пример с порталом, то, помимо админа, потребуется пользователь-редактор, набивающий информационное наполнение портала.
Клиентская часть может потребовать услуг админа по инсталляции ее на компьютер пользователя. Так что все можно, исходя из разумной необходимости.
Что касается требований ГОСТ 19, то они не запрещают расширения структуры любого документа за счет добавления дополнительных разделов, подразделов и т.д. Можно посмотреть здесь.
- Войдите на сайт для отправки комментариев
Уточнение (и вопрос) в топик.
Подготавливаю руководство оператора клиентской части ПО согласно ГОСТ 19.
Сфера использования:
- информационная безопасность (борьба с инсайдерами и отслеживание конфиденцильной информации в локальной сети)
- управление документооборотом (поиск, структурирование инфы и тд).
Понятное дело, что сертифицировать ПО планируется только в разрезе инфобеза.
Использую свои старые материалы, которые не были заточены именно под инфобез.
Используется толстый клиент с широким набором функций.
Расклад такой: в старой справке всего 80 топиков, из них к инфобезу относится только 25-30. Соответственно, остальные разделы к инфобезу никакого касательства не имеют.
6. Понятное дело, что работу лишнюю брать на себя не хочется. И как же быть? Вижу три варианта:
- Не включать непрофильные темы вообще
- Включить очень урезанные сведения в приложения к руководству оператора
- Включить всю информацию (скорее всего, тоже в приложения)