Разработка технической документации и технические писатели Технические писатели и разработка технической документации технические писатели в Телеграм 

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
Ответить
RSS
Документация для системных аналитиков (руководство системного аналитика), как писать документацию для системных аналитиков
 
На работе поставили задачи, написать руководство пользователя, написал, оказалось, что нужно не то. Вообщем хотят в одном руководстве уместить все про систему, чтобы она подходила: пользователям, аналитикам, программистам. Объяснил, что это нереально, в итоге остановились что это документация больше будет относится к аналитикам, т.е как и что настраивать в системе. Никогда ничего подобного не писал. У кого-нибудь есть примеры или представление как это должно быть написано?  
 
Живых примеров пока не было, но на горизонте маячит похожая задача.
Насколько я понимаю, суть работы состоит в том, что, помимо описания пользовательского интерфейса, в руководство следует включать описание набора технологий, поддерживаемых продуктом. В первую очередь, это механизмы взаимодействия с внешней средой (другими системами). По крайней мере, я планирую плясать от этого, а дальше по обстоятельствам
 
Цитата
writer пишет:
в итоге остановились что это документация больше будет относится к аналитикам, т.е как и что настраивать в системе.
С каких это пор системные аналитики что-то настраивают?
 
Цитата
ADVANCED пишет:
Цитата
writer пишет:
в итоге остановились что это документация больше будет относится к аналитикам, т.е как и что настраивать в системе.
С каких это пор системные аналитики что-то настраивают?
Да всегда настраивали  :) ) Например, взять BI.
Изменено: techwriter - 26.09.2014 10:28:41
techwriter.ru.com
 
Цитата
writer пишет:
Объяснил, что это нереально, в итоге остановились что это документация больше будет относится к аналитикам, т.е как и что настраивать в системе.
Я бы написала руководство администратора, потому что в данном случае системный аналитик выступает в роли администратора. Если я правильно поняла задачу :))
techwriter.ru.com
 
У нас аналитики настраиваю все "от" и "до". Сейчас пишу странный гибрид руководство администратора и пользователя.
Тут в чем сложность, аналитик должен уметь настраивать систему под бизнес-требования заказчика и соответственно ни администраторская, ни пользовательская документация не подходит т.к для пользователя нужно знать только что нажимать, а администратору не нужно знать всех тонкостей настроек под определенные задачи, ему нужно только понимать как это работает. на самом деле странно, что такого документа раньше не было и не описана технология его написания.
 
Цитата
writer пишет:
У нас аналитики настраиваю все "от" и "до".
Может проще им переименовать должность? ))))
Аналитик должен анализировать то, чего еще не существует и может выполнить приемочное тестирование того, что сделали программисты, до того как пустили в релиз.
 
Цитата
ADVANCED пишет:
Цитата
writer пишет:
У нас аналитики настраиваю все "от" и "до".
Может проще им переименовать должность?  ))))  
Аналитик должен анализировать то, чего еще не существует и может выполнить приемочное тестирование того, что сделали программисты, до того как пустили в релиз.
Да это нормальная практика. Аналитик вполне может делать бизнес- и системные настройки приложения перед его использованием.
techwriter.ru.com
 
Цитата
techwriter пишет:
Да это нормальная практика. Аналитик вполне может делать бизнес- и системные настройки приложения перед его использованием.
у нас так и делают, аналитики выявляют требования заказчика, а потом настраивают ПО под эти требования, программисты же этого тоже делать не должны
 
Цитата
writer пишет:
Цитата
techwriter пишет:
Да это нормальная практика. Аналитик вполне может делать бизнес- и системные настройки приложения перед его использованием.
у нас так и делают, аналитики выявляют требования заказчика, а потом настраивают ПО под эти требования, программисты же этого тоже делать не должны
Просто бывают так называемые бизнес-настройки (точнее, я их так называю). Например, есть система электронного документооборота. На всех филиалах организации используют стандартную схему документооборота. Но есть, например, филиал, в котором используется нестандартная схема (применимая только к данному филиалу), которая базируется на стандартной. Не будешь же из-за них, новый модуль делать. Проще сделать настройку, которая автоматически имеет значения стандартной схемы документооборота. А для конкретно этого филиала устанавливаются настройки, чтобы была реализована их нестандартная  схема. И делает это аналитик, потому что он знает, на каких филиалах какая бизнес-логика.
techwriter.ru.com
 
Цитата
writer пишет:
программисты же этого тоже делать не должны
Вот именно, что не должны. Просто аналитик выполняет роль администратора системы. Для него пишется руководство администратора. В аннотации прописывается, для какой целевой аудитории рассчитан документ. В данном случае - аналитик.
techwriter.ru.com
Страницы: 1
Ответить
Читают тему
Форма ответов
 
Текст сообщения*
Загрузить файл или картинкуПеретащить с помощью Drag'n'drop
Перетащите файлы
Ничего не найдено
Загрузить картинки
Отправить Отменить