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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Как вы начинаете разрабатывать пользовательскую документацию? Содержание документа Руководство пользователя, Содержание документа, планирование содержания пользовательской документации
 
Вопрос, собственно, в разработке содержания будущего руководства:
Есть программа, нужно написать Руководство пользователя
Вопрос: Как вы решаете, какое содержание будет у документа? Отталкиваетесь от Меню программы, от Задач, которые решает программа, от Бизнес-процессов или...?

 
 
writer, вот я как раз в такой ситуации сейчас. Новое место работы в конторе, в головы руководителям которой внезапно пришла светлая мысль о том, что нужна документация. А так как они понятия не имеют чего им надо, мне пришлось сидеть и долго чесать голову. Поэтому сейчас я сижу, набрасываю варианты реализации. Составляю предположительные варианты комплекта документации, набрасываю скелеты отдельных документов, пытаюсь получить внятные отзывы на всё это. Пока решили остановиться на одном талмуде с описаниями функциональности системы (отталкиваясь от меню), а потом сделать отдельные руководства для нескольких основных ролей (отталкиваясь от задач и бизнес-процессов).

На прошлом месте разрабатывались две системы для одного заказчика, но руководства писались по-разному: одно пошаговое, чисто по пунктам меню, второе на основе выполняемых задач. Просто потому, что так было намного удобнее с точки зрения функционирования самих систем: связи между объектами в первой были прозрачными, а во второй приходилось долго думать над вопросами "А как же оно так получилось? Куда мы нажали? Зачем вообще эта кнопка в данном меню?! О_О"

В общем как по мне, так надо сначала выполнить 3-4 масштабных действия в программе, посмотреть на взаимодействие различных модулей, а там основа повествования должна сформироваться сама. Или вот ещё вариант: просто начать описывать, отталкиваясь от меню. У меня один раз было так, что повествование просто не выстраивалось, приходилось делать кучу перекрестных ссылок или описывать одно и то же по несколько раз, так что там "описание от задач" выбрало себя само.  
 
Цитата
writer написал:
нужно написать Руководство пользователя
Вопрос: Как вы решаете, какое содержание будет у документа? Отталкиваетесь от Меню программы, от Задач, которые решает программа, от Бизнес-процессов или...?
Решать надо на основе ГОСТ Р ИСО/МЭК 15910—2002 "Процесс создания документации пользователя программного средства"
 
Ranaloc спасибо за советы, у меня тоже это актуально сейчас

Виктор, а если ГОСТы в компании не используются?  
 
Цитата
Виктор Фигурнов написал:
Цитата
writer   написал:
нужно написать Руководство пользователя
Вопрос: Как вы решаете, какое содержание будет у документа? Отталкиваетесь от Меню программы, от Задач, которые решает программа, от Бизнес-процессов или...?
Решать надо на основе ГОСТ Р ИСО/МЭК 15910—2002 "Процесс создания документации пользователя программного средства"
Вопрос, скорее всего, затрагивает ту часть руководства где говорится на какие кнопки нажимать и что будет происходить.

Пользователь использует ПО чтобы решить некие конкретные задачи (как было сказано ранее). Соответственно, он должен выполнить некие действия. Вот их и надо описывать. А меню может быть криво (интуитивно непонятно / неудобно / непривычно) скомпоновано.

Например, Word 2007.
Хочу вставить рисунок - выбираю вкладку меню "Вставить", на ней выбираю "Рисунок". Всё прозрачно и понятно: перефразируя "Как слышится так и пишется" получаем нечто типа "Что требуется - то в меню и выбирается".
Хочу вставить примечание - рука тянется выбрать вкладку "Вставить", а нужна вкладка "Рецензирование". С ходу неподготовленный человек может и не догадаться. Приходится шариться по меню или гуглить. А если гуглим, то, опять же, ищем набор конкретных действий.

Так что отталкиваться лучше от задач, которые решает программа.
 
Скажите пожалуйста, а как аргументировать выбор тех или иных ГОСТ'ов для написания документации к программному обеспечению? Т.е. я пытаюсь сейчас решить ту же задачу, пришёл к тому, что нужно выбрать ГОСТ'ы, но самих гостов то же как оказалось не маленькое количество, и какой из них выбрать, а самое главное надо будет объяснить внятно, почему я выбрал именно этот ГОСТ.
Подскажите пожалуйста
 
Цитата
R-Magistr написал:
Скажите пожалуйста, а как аргументировать выбор тех или иных ГОСТ'ов для написания документации к программному обеспечению? Т.е. я пытаюсь сейчас решить ту же задачу, пришёл к тому, что нужно выбрать ГОСТ'ы, но самих гостов то же как оказалось не маленькое количество, и какой из них выбрать, а самое главное надо будет объяснить внятно, почему я выбрал именно этот ГОСТ.
Подскажите пожалуйста
А чего тут аргументировать-то? Для написания документации к ПО используется ЕСПД (единая система программной документации), т.е. ГОСТы серии 19.ХХХ. Вот здесь посмотрите http://techwriters.ru/services-for-technical-writers/gosts-and-standards/gost/gost-19-xxx-espd/
А уж из списка этих ГОСТов выбирайте необходимые, вряд ли нужны будут все документы.  
 
Цитата
Виктор Фигурнов написал:
Решать надо на основе ГОСТ Р ИСО/МЭК 15910—2002 "Процесс создания документации пользователя программного средства"
Виктор, а можно подробнее? В этом ГОСТ, описывается как создавать структуру документа?
Страницы: 1
Читают тему