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

1. Функции технического
писателя в работе
аналитика
Личные качества, знания, навыки
Свешникова Н.В.
Москва, 2008
1

2. Технический
Сегодня вы узнаете…
писатель
• Какую функции технического писателя
выполняет аналитик?
• Какими личными качествами он должен
обладать?
• Какие знания и навыки наиболее
востребованы?
• Чем руководствуется технический писатель
при выполнении своей работы?
2

3. Технический
Выполняемая работа
писатель
Составление проектной документации,
фиксация информации в письменном виде
• Технические задания
• Сценарии использования и тестирования
• Пользовательские инструкции
В ходе лекции мы остановимся подробнее на
этих типах документов
3

4. Технический Личные качества, знания,
писатель навыки
Что нужно для успешного выполнения функций
технического писателя?
• Личные
качества самостоятельность,
ответственность,
умение работать в команде,
внимательность и
• Знания аккуратность
• Навыки
4

5. Технический Личные качества, знания,
писатель навыки
Что нужно для успешного выполнения функций
технического писателя?
• Личные
качества
грамотный русский язык,
понимание стилистических
• Знания особенностей документов,
умение четко,
последовательно и
• Навыки структурировано
излагать свои мысли.
Предметная область
5

6. Технический Личные качества, знания,
писатель навыки
Что нужно для успешного выполнения функций
технического писателя?
• Личные
качества
• Знания
MS Word,
MS Excel,
• Навыки MS Visio
и т.п.
6

7. Технический Компетенция:
писатель Самостоятельность
Поведенческие индикаторы
• Аналитик самостоятельно распределяет время
между несколькими заданиями, руководствуясь
срочностью работ, определенной руководителем
проекта, и своими оценками трудозатрат.
• Аналитик самостоятельно ищет способы
решения поставленных задач, используя совет
коллег, книги или ресурсы Интернета. Его главный
вопрос не «Как сделать?», а «Лучше сделать так
или так?».
7

8. Технический Практикум:
писатель Самостоятельность
Ситуация: Менеджер проекта сообщает, что через пару
недель Вам предстоит участвовать в проекте,
использующем новое для Вас ПО. Ваши действия?
• Отказаться из-за недостатка компетенции?
• Попросить имеющиеся материалы?
• Узнать, кто из коллег работал с ПО и попросить
провести лекцию?
• Выделить в графике работы время для изучения?
• Изучать материал в свободное от работы время?
• Дождаться начала проекта и изучать ПО «в бою»?
8

9. Технический Компетенция:
писатель Ответственность
Поведенческие индикаторы
• Аналитик не только самостоятельно принимает
решения, но и может их обосновать, вести в их
защиту аргументированный спор.
• Аналитик умеет признавать ошибки,
исправлять их и учиться на них. В ситуации
обнаружения низкого качества работы или ошибки
аналитик не оправдывается, а пытается
проанализировать причины, чтобы избежать
подобной ситуации в будущем.
9

10. Технический Практикум:
писатель Ответственность
Ситуация: Вы получаете от менеджера проекта
довольно резкое письмо о качестве выполненных
Вами работ. Ваши действия?
• Ничего не предпринимать?
• Пожаловаться руководителю отдела?
• Ответить менеджеру в том же тоне?
• Попросить менеджера обсудить с Вами проблему и
исправить допущенные ошибки?
• Пересмотреть и проанализировать результаты, которые
подверглись критике?
10

11. Технический Компетенция: Умение
писатель работать в команде
Поведенческие индикаторы
• Аналитик готов к обмену опытом. Он проявляет
интерес не только к своим задачам, но и к задачам
коллег.
• Аналитик может подменить коллегу, быстро
включается в новую задачу.
• Аналитик не перекладывает свою работу на
плечи коллег (затягивая сроки, не заканчивая
работу перед отпуском или отказываясь от
выполнения работы).
11

12. Технический Практикум: Умение
писатель работать в команде
Ситуация: Вы получаете довольно объемное задание
за неделю до отпуска. Ваши действия?
• Отказаться от задания?
• Взять задание, но предупредить, что можете не успеть?
• Сделать, сколько успеете?
• Поторопиться, чтобы сделать все?
• Оценить, какой объем работы вы успеете сделать.
Обсудить оценку с менеджером и договориться о сдвиге
сроков или замене Вас на время отпуска?
• Отменить отпуск?
12

13. Компетенция:
Технический
Внимательность и
писатель
аккуратность
Поведенческие индикаторы
• Аналитик понимает, что результаты его работы
предназначены для других людей. Он думает о
тех, кто будет читать его творение, будь то
коллега, начальник, заказчик или случайный
посетитель корпоративного сайта.
• Аналитик уделяет внимание и содержанию и
форме. Документы всегда аккуратно оформлены,
четко структурированы, безупречны с точки
зрения стиля и правописания.
13

14. Технический
Знания: русский язык
писатель
Русский язык нам всем родной. Современные текстовые
редакторы предоставляют довольно развитые возможности
проверки орфографии и грамматики. И все-таки
встречаются вот такие интересные примеры…
14

15. Технический Практикум: анализ
писатель грамматики в MS Word
Приведен пример из документа с разметкой проверки
грамматики MS Word. Найдите ошибки.
Автоматическая проверка орфографии и грамматики –
хорошее средство против опечаток, но она не
освобождает от необходимости думать.
15

16. Технический Практикум: некоторые
писатель случаи правописания частиц
Не или Ни? Слитно или раздельно? Почему?
16

17. Технический Практикум: некоторые
писатель случаи правописания частиц
Ответы:
Правило: Сочетания «не кто иной (другой), как» имеют
значение противопоставления, в них пишется отрицательная
частица не. Сочетания «никто иной (другой)» не связаны с
противопоставлением. 17

18. Технический Практикум: некоторые
писатель случаи правописания союзов
Слитно или раздельно? Почему?
18

19. Технический Практикум: некоторые
писатель случаи правописания союзов
Ответы:
Правило: Отличить союз «чтобы» местоимения с частицей «что
бы» можно, попробовав переставить «бы» в предложении.
Союзы «тоже» и «также» употребляются в значении «и». В то
время как «то же» и «так же» - для сравнения «так же, как». 19

20. Технический Практикум: согласование
писатель слов в предложении
Приведены неверно или неудачно составленные
предложения. Исправьте, объясните ошибки.
1. Влажность воздуха составляет 76,5 процентов.
2. Машины стояли у обоих ворот.
3. До начала экзаменов осталось полтора учебного месяца.
20

21. Технический Практикум: согласование
писатель слов в предложении
Ответы:
Правило 1: При смешанном арифметическом числе
существительное управляется дробью, а не целым числом:
10,2 процента (а не «процентов»).
Правило 2: Так как нельзя сказать ни «оба ворота», ни «обе
ворота», то не может быть и сочетания «у обоих ворот».
Следует сказать: у тех и других ворот или у одних и у других
ворот.
Правило 3: При сочетании числительного полтора с
существительным определение ставится в форме
множественного числа: полтора полных стакана. 21

22. Технический Практикум: употребление
писатель местоимений
Приведены неверно или неудачно составленные
предложения. Исправьте, объясните ошибки.
1. Мальчик теперь сирота; отец умер, когда ему было три года.
2. Группа сдала все зачеты и просила проэкзаменовать их в
первую очередь.
3. Больной попросил сестру налить себе воды.
22

23. Технический Практикум: употребление
писатель местоимений
Ответы:
Правило 1: Местоимение обычно заменяет ближайшее к нему
предшествующее существительное. Нарушение этого
положения ведет к искажению смысла.
Правило 2: Собирательное существительное нельзя заменять
местоимением в форме множественного числа. Чтобы не
создавать неудобное сочетание, следует собирательное
слово заменить словом «студенты» или «учащиеся».
Правило 3: Возвратные местоимения себя и свой относятся к
лицу, производящему действие.
23

24. Технический Практикум: согласование
писатель слов в предложении
Приведены неверно или неудачно составленные
предложения. Исправьте, объясните ошибки.
1. Ряд столов стояли посередине аудитории.
2. На совещание прибыли пятьдесят один делегат.
3. Отпущено миллион рублей на благоустройство поселка.
4. На экскурсию пошли всего десять школьников.
24

25. Технический Практикум: согласование
писатель слов в предложении
Ответы:
Правило 1: При подлежащем, выраженном именем
существительным собирательным (ряд, большинство,
меньшинство, часть и т.п.) в сочетании с родительным
падежом множественного числа, сказуемое обычно ставится
во множественном числе, если речь идет о предметах
одушевленных и в единственном числе, если подлежащее
обозначает предметы неодушевленные.
Правило 2: При составных числительных, оканчивающихся
на один, сказуемое ставится в единственном числе
25

26. Технический Практикум: согласование
писатель слов в предложении
Ответы:
Правило 3: При словах тысяча, миллион, миллиард сказуемое
обычно ставится в единственном числе и согласуется в роде.
Правило 4: Если при счетном обороте имеются слова «все»,
«эти», то сказуемое ставится только во множественном
числе. Наоборот, при наличии слов «всего», «только»,
«лишь» сказуемое ставится в единственном числе.
26

27. Технический
Как избежать ошибок?
писатель
• Загляните в старые добрые учебники, купите сборник
упражнений Розенталя, посетите ресурс
www.gramota.ru
• Внимательно продумывайте предложения и
перечитывайте документ перед отправкой
результата. Обязательно пользуйтесь
автоматической проверкой, но не полагайтесь на
нее одну.
• Если возникают сомнения, лучше переформулируйте
предложение. Разбейте на более простые части,
используйте синонимы.
27

28. Технический
Перерыв 5 минут
писатель
• Вопросы?
• Перерыв 5 минут.
28

29. Технический Назначение документа и
писатель целевая аудитория
К разным документам выдвигаются различные требования,
связанные с его назначением и целевой аудиторией.
Но в чем отличия?
Документы могут
Это определяет
• нести разное количество
их объем
информации
• быть предназначены для людей Это определяет
их лексику
различного уровня знаний
Это определяет
• предназначаться для изучения
структуру
или использоваться материала
как справочные материалы
29

30. Технический Практикум: Какими
писатель должны быть документы?
Выделить характерные особенности
• делового электронного письма,
• художественного романа,
• технической документации на ПО.
Этапы анализа:
1. Определить цель составления текста
2. Определить соотношение объема
передаваемой информации и времени,
которое ей готов уделить читатель
3. Определить целевую аудиторию
30

31. Технический Итоги практикума: Какими
писатель должны быть документы?
Документ Техническая
E-mail Роман
Этапы документация
Большой объем,
Цель, объем Небольшой
Большой объем специализированная
информации объем
информация
Время Минимально Минимально
Не ограничено
читателя возможное возможное
Определенный
Целевая Широкая
человек или Широкая аудитория
аудитория несколько
аудитория
Краткое Большой объем, Строгая структура,
сообщение, художественный для минимального
Выводы лексика в стиль, времени поиска
зависимости от пространные информации,
адресата рассуждения подробные пояснения
31

32. Технический Структура документа:
писатель простые приемы
• Обязательно наличие содержания и структуры глав и
секций для быстрого ориентирования. Проставляйте номера
страниц;
• Разместите в начале документа список терминов и
сокращений. Начните документ с раздела «Введение» или
«Общая информация»;
• Перечисление элементов, шаги инструкций и т.п. оформляйте
в виде списков. Если список сопровождается
дополнительными свойствами элементов, требуется
табличное представление;
• Не пренебрегайте ссылками. При работе с электронной
версией документа они удобны.
32

33. Технический Оформление документа:
писатель разумный минимум
• Узнайте о корпоративных традициях оформления
документов. Если таковых нет, единожды сформируйте свою
манеру оформления и убедитесь, что она не страдает при
выводе на черно-белую печать;
• Некоторые рекомендации
• Выравнивайте абзацы по ширине, пользуйтесь красной
строкой или делайте отступы между абзацами;
• Используйте шрифт по умолчанию: Times New Roman, 12pt;
• Выделяйте заголовки таблиц цветом фона или жирным шрифтом.
Текст таблицы может быть выровнен влево или по центру. Размер
шрифта в таблицах может быть уменьшен до 8 – 10pt.
• Используйте повсеместно одинаковое оформление, если
иное не предписано постановкой задачи. 33

34. Технический Язык документа: не
писатель разрушить впечатление
• Будьте внимательны к орфографии, синтаксису и стилистике;
• Избегайте сложных длинных предложений и заголовков.
Чем сложнее излагаемый материал, тем проще должен быть язык;
• Все термины выносите в отдельную секцию и поясняйте;
• Не перегружайте документ аббревиатурами. По крайней мере,
убедитесь, что при первом употреблении аббревиатуры вы
приводите ее расшифровку, а лучше отдельно привести полный
перечень используемых аббревиатур с расшифровкой;
• Сопровождайте текст рисунками и схемами. Именно
сопровождайте, а не заменяйте одно другим. Только в сочетании
они дают желаемый эффект
34

35. Технический
Типы документов
писатель
Познакомившись с общими правилами и рекомендациями,
мы можем перейти к рассмотрению
отдельных типов документов виде
• Технические задания
• Сценарии использования и тестирования
• Пользовательские инструкции
35

36. Технический
Техническое задание
писатель
Техническое задание (Specification, technical standard) –
это документ, описывающий требования,
которым должен соответствовать проектируемый
и/или разрабатываемый продукт.
ТЗ содержит
• основные технические требования;
• назначение, область применения;
• стадии разработки, состав, сроки исполнения и т. д.
ТЗ составляют на основе анализа результатов
обследования, расчётов и моделирования
36

37. Технический Техническое задание и
писатель спецификация
Техническое задание Спецификация
Более наглядный, не Более подробное и более
содержащий техническое описание
технических разрабатываемого
подробностей продукта,
реализации документ, предназначенное для
предназначенный для архитектора и
заказчика программистов
37

38. Технический Как писать ТЗ?
писатель Стандарты и содержание
Инструкция по написанию – это ГОСТы и стандарты.
• 19.201-78. Техническое задание. Требования к
содержанию и оформлению;
• 34.602-89. Техническое задание на создание
автоматизированной системы;
• IEEE (Institute of Electrical and Electronics Engineers);
• SWEBOK (Software Engineering Body of Knowledge).
38

39. Технический
Сценарии использования
писатель
Сценарий использования содержит подробное описание
действий пользователя и откликов системы, приводящих к
выполнению поставленной задачи
Задача: добавить пользователя в систему.
Сценарий использования:
1. Пользователь входит в систему в качестве администратора,
переходит на страницу «Пользователи». Открывается список
существующих в системе пользователей.
2. Пользователь нажимает на кнопку «Создать», открывается
карточка, содержащая поля: Имя пользователя, логин, пароль.
3. Пользователь заполняет поля и нажимает кнопку OK. Система
возвращается к списку пользователей, созданный пользователь
отображается в списке. И т.д. 39

40. Технический
Сценарии тестирования
писатель
Сценарии тестирования предназначены для проверки результатов
разработки и схожи со сценариями использования
Задача: добавить пользователя в систему.
Сценарий тестирования:
1. Войти в систему под пользователем admin;
2. Выбрать в меню пункт «Пользователи». Открывается список
существующих в системе пользователей.
3. Нажать на кнопку «Создать». Открывается карточка, содержащая
поля: Имя пользователя, логин, пароль.
4. Ввести Имя «Иван Иванов», логин Ivanov, пароль 123456. Нажать
OK. Система возвращается к списку пользователей
5. Убедиться, что пользователь Иванов появился в списке. И т.д. 40

41. Технический Пользовательская
писатель документация
Инструкция, поясняющая, как выполнить ту или иную операцию.
Задача: добавить пользователя в систему.
Фрагмент руководства администратора:
1. Выберите в меню пункт «Пользователи». Нажмите на
кнопку «Создать»;
Приведен скрин-шот, кнопка «Создать» выделена яркой рамкой
2. Открывается карточка.
Приведен скрин-шот.
3. Введите имя, логин, пароль и нажмите кнопку OK.
И т.д.
41

42. Технический Навыки владения
писатель инструментами
управление форматированием,
MS Word
работа с таблицами, списками,
стилями, примечаниями, ссылками
составление содержания,
MS Excel знакомство с работой в
режиме track changes
MS Visio
Adobe Photoshop
42

43. Технический Навыки владения
писатель инструментами
MS Word
управление форматированием,
свойствами ячеек,
MS Excel работа с формулами,
сортировки,
фильтры,
группировки,
сводная таблица (pivot-table)
MS Visio
Adobe Photoshop
43

44. Технический Навыки владения
писатель инструментами
MS Word
MS Excel
Требования к MS Visio
относятся в основном к
пониманию правил и/или
MS Visio стандартов нескольких типов схем:
UML,
Windows XP User Interface
и некоторых других.
Adobe Photoshop
44

45. Технический Навыки владения
писатель инструментами
MS Word
MS Excel
MS Visio
Достаточно поверхностного знакомства
в качестве вспомогательного
средства для подготовки
Adobe Photoshop иллюстраций.
45

46. Введение | Подведем итоги
Самостоятельность Компетениции Команда
Ответственность Аккуратность
Офисные Технический Типы
инструменты писатель документов
Русский язык Знания Основы
стилистика, составления
правописание документов
46

47. Введение | Заключение
• Вопросы?
47

48. Введение | Литература
 Розенталь Д. Э. «Русский язык: Сборник упражнений для
поступающих в вузы» - М.: Дрофа, 1997. – 240 стр.
 ГОСТ 19.201-78 Единая система программной документации.
Техническое задание. Требования к содержанию и оформлению
http://www.nist.ru/hr/doc/gost/19201-78.htm
 ТЕХНИЧЕСКОЕ ЗАДАНИЕ НА СОЗДАНИЕ АВТОМАТИЗИРОВАННОЙ
СИСТЕМЫ http://www.nist.ru/hr/doc/gost/34-602-89.htm
 SWEBOK
48