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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
Ответить
RSS
Разработка типовых сценариев работы с системой, Обсуждаем разработку типовых сценариев работы с системой
  1. В вашей компании разработаны типовые сценарии работы с системой?
 
Коллеги, последнее время во многих компаниях разработчики технической документации стали составлять отдельный документы по типовым сценариям работы с ПО. Давайте обсудим рекомендации по их разработке, используемые приемы, структуру и т.д. на мой взгляд это очень полезный документ.  
 
А что из себя представляет типовой сценарий работы с ПО и чем он отличается от инструкции или руководства?
techwriter.ru.com
 
А какая там структура может быть? Вопроc- ответ.

Как распечатать консолидированный отчет МСФО за 2014 год?
Открыть то-то, нажать то-то бла-бла-бла... ну и пару примечаний, про права доступа и проверку бумаги в принтере перед печатью. Все.  
 
Мы расписываем по шагам:

Шаг 1:
Сделать то-то, результат такой-то, скрин со стрелками для наглядности. Ссылка на место в руководстве.
Работать надо не 12 часов, а головой.
 
Делюсь, набором анкет:
ЕМ-Д-01 Анкета для оценки инструкции по процессу/процедуре,
ЕМ-Д-02 Анкета для оценки Положения о подразделении,
ЕМ-Д-03 Анкета для оценки должностной инструкции,
скачать АНКЕТЫ - doc

PS: Найдено в открытых источниках интернета
 
Цитата
ADVANCED пишет:
А какая там структура может быть? Вопроc- ответ.

Как распечатать консолидированный отчет МСФО за 2014 год?
Лучше расскажите, как создать консолидированный отчет МСФО за 2014 год. Вопрос-ответ.
Распечатать-то не проблема, и вряд ли процедура его печати отличается от процедуры печати других документов.
 
Цитата
Виктор Фигурнов пишет:
Цитата
ADVANCED пишет:
А какая там структура может быть? Вопроc- ответ.

Как распечатать консолидированный отчет МСФО за 2014 год?
Лучше расскажите, как создать консолидированный отчет МСФО за 2014 год. Вопрос-ответ.
Распечатать-то не проблема, и вряд ли процедура его печати отличается от процедуры печати других документов.
Это рассказывается в предыдущем шаге также в виде Вопрос-Ответ с названиями окон, кнопок и форм. И скриншоты тоже добавляются.
 
Цитата
ADVANCED Это рассказывается в предыдущем шаге также в виде Вопрос-Ответ с названиями окон, кнопок и форм. И скриншоты тоже добавляются.
Я спросил "как создать" - а вы отвечаете на совсем другой вопрос: "где это должно быть описано".    I-о  

У меня рядом стоят две книжки о том, как составлять консолидированную финансовую отчетность по МСФО - одна на 370 страниц, другая - 720 страниц большого формата.

И я не могу сказать, что там есть что-то лишнее.

Вы уверены, что столь обширный и методически сложный предмет можно изложить в виде "предыдущего шага" с названиями окон, кнопок и форм, и скриншотов?  :D
 
Цитата
Виктор Фигурнов пишет:
Цитата
ADVANCED Это рассказывается в предыдущем шаге также в виде Вопрос-Ответ с названиями окон, кнопок и форм. И скриншоты тоже добавляются.
Я спросил "как создать" - а вы отвечаете на совсем другой вопрос: "где это должно быть описано".

У меня рядом стоят две книжки о том, как составлять консолидированную финансовую отчетность по МСФО - одна на 370 страниц, другая - 720 страниц большого формата.

И я не могу сказать, что там есть что-то лишнее.

Вы уверены, что столь обширный и методически сложный предмет можно изложить в виде "предыдущего шага" с названиями окон, кнопок и форм, и скриншотов?
Уверен, что можно. Но я не должен на форуме отвечать как это сделать, это отступление от темы.
Тут написано как его создать http://techwriters.ru/forum/messages/forum598/topic19760/message10420/#message10420.    :)  


Если вас пугают масштабы, пусть "бла-бла" будет на пять страниц, куча скриншотов, еще множество форм, таблиц и представлений. Результат один: структура типового сценария = вопрос-ответ.  
Изменено: ADVANCED - 01.07.2014 16:35:53
 
Цитата
techwriter пишет:
А что из себя представляет типовой сценарий работы с ПО и чем он отличается от инструкции или руководства?
ну к примеру, есть банковское ПО, руководство пользователя описывает всю инструкцию для пользователя, что нужно и не нужно, а типовой сценарий работы, это что-то типа "Как положить денежку на карту", "Как снять денежку", "Как посмотреть баланс на карте" вот такие сценарии.
 
Цитата
techwriter пишет:
А что из себя представляет типовой сценарий работы с ПО и чем он отличается от инструкции или руководства?
Сценарий использования описывает один способ, с помощью которого продукт (или система) может быть использован для достижения определенной цели. Как правило, сценарий использования содержит пошаговое руководство по выполнению необходимых для этого действий. Более подробно смотрите здесь:

http://deseng.ryerson.ca/dokuwiki/design:usage_scenario
http://www.redline-software.com/eng/products/surfcop/scenarios/

Сценарии использования также широко используются на этапе проектирования. См., например, A. Cockburn "Writting Effective Use Cases" http://alistair.cockburn.us/get/2465

Сценарии, которые пишутся на этапе проектирования, должны описывать, что именно система должна сделать, чтобы пользователь (актер) достиг своей цели; не затрагивать деталей реализации, иметь достаточный уровень детализации и не описывать пользовательские интерфейсы, экраны и т. д. (т. к. это делается впоследствии — при дизайне пользовательского интерфейса).

Иногда различают "usage scenario" и "use case" - первый вид сценариев более персонализированный и конкретный, а второй - более общий, в котором может рассматриваться не конкретная задача, а класс задач, и в котором могут описываться различные варианты (ответвления) сценария.
 
Виктор, огромное спасибо за ссылки и грамотное объяснение того, что есть -  сценарии! vipivka-smile
 
Цитата
writer пишет:
ну к примеру, есть банковское ПО, руководство пользователя описывает всю инструкцию для пользователя, что нужно и не нужно, а типовой сценарий работы, это что-то типа "Как положить денежку на карту", "Как снять денежку", "Как посмотреть баланс на карте" вот такие сценарии.
В руководстве пользователя разве эти действия не описываются? Изложение руководства пользователя может идти от интерфейса и от действий пользователя. Я обычно исхожу как раз от действий пользователя. Если изложение от действий, то в нем оно строится таким образом: цель, которую нужно достичь пользователю - действия, которые необходимо выполнить. Если достичь цель можно несколькими способами, то описываются все случаи. Я так понимаю, что сценарии просто кратко описывают процедуру выполнения действий пользователя для достижения целей (без подробного описания полей формы, например). Допустим, "Зайдите в такой-то раздел, нажмите такую-то кнопку, заполните такую-то форму и т.д., и т.п. Мне даже больше тест-кейсы напоминает, чем юз-кейсы. Только более мультимедийные.
techwriter.ru.com
 
Цитата
Виктор Фигурнов пишет:
Более подробно смотрите здесь:

http://deseng.ryerson.ca/dokuwiki/design:usage_scenario
http://www.redline-software.com/eng/products/surfcop/scenarios/
Такие сценарии, скорее, при проектировании пишутся.
techwriter.ru.com
 
Цитата
techwriter пишет:
В руководстве пользователя разве эти действия не описываются?
Не всегда, сценарии это на мой взгляд более жизненные примеры и , действительно, более наглядные.
 
Цитата
writer пишет:
Не всегда, сценарии это на мой взгляд более жизненные примеры и , действительно, более наглядные.
Я сейчас как раз описываю примеры настройки интерфейса (списков, форм). Но я там пишу по такому принципу: если ввести такое-то значение, то будет так-то. И прилагаю скриншот с результатом.
techwriter.ru.com
 
Случайно наткнулась:
http://www.agiledocs.com/writing-user-stories-agile-infographic/
techwriter.ru.com
Страницы: 1
Ответить
Читают тему
Форма ответов
 
Текст сообщения*
Загрузить файл или картинкуПеретащить с помощью Drag'n'drop
Перетащите файлы
Ничего не найдено
Загрузить картинки
Отправить Отменить