Функции технического писателя в работе аналитика

1

Функции технического писателя в работе аналитика

Личные качества, знания, навыки

Москва, 2008

Свешникова Н.В.

2

• Какую функции технического писателя выполняет аналитик?

• Какими личными качествами он должен обладать?

• Какие знания и навыки наиболее востребованы?

• Чем руководствуется технический писатель при выполнении своей работы?

Технический писатель

Сегодня вы узнаете…

3

• Технические задания

• Сценарии использования и тестирования

• Пользовательские инструкции

В ходе лекции мы остановимся подробнее на этих типах документов

Составление проектной документации, фиксация информации в письменном виде


Выполняемая работа

4

• Личные качества

• Знания

• Навыки

Что нужно для успешного выполнения функцийтехнического писателя?



самостоятельность, ответственность,

умение работать в команде, внимательность и

аккуратность

5


• Знания

• Навыки




грамотный русский язык, понимание стилистических особенностей документов,

умение четко, последовательно и структурировано

излагать свои мысли. Предметная область

6


• Знания

• Навыки




MS Word, MS Excel, MS Visio

и т.п.

7

Поведенческие индикаторы

• Аналитик самостоятельно распределяет время

между несколькими заданиями, руководствуясь срочностью работ, определенной руководителем проекта, и своими оценками трудозатрат.

• Аналитик самостоятельно ищет способы решения поставленных задач, используя совет

коллег, книги или ресурсы Интернета. Его главный вопрос не «Как сделать?», а «Лучше сделать так или так?».


Компетенция: Самостоятельность

8

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

• Отказаться из-за недостатка компетенции?

• Попросить имеющиеся материалы?

• Узнать, кто из коллег работал с ПО и попросить провести лекцию?

• Выделить в графике работы время для изучения?

• Изучать материал в свободное от работы время?

• Дождаться начала проекта и изучать ПО «в бою»?


Практикум: Самостоятельность

9


• Аналитик не только самостоятельно принимает решения, но и может их обосновать, вести в их

защиту аргументированный спор.

• Аналитик умеет признавать ошибки, исправлять их и учиться на них. В ситуации

обнаружения низкого качества работы или ошибки аналитик не оправдывается, а пытается

проанализировать причины, чтобы избежать

подобной ситуации в будущем.


Компетенция: Ответственность

10

Ситуация: Вы получаете от менеджера проекта довольно резкое письмо о качестве выполненных Вами работ. Ваши действия?

• Ничего не предпринимать?

• Пожаловаться руководителю отдела?

• Ответить менеджеру в том же тоне?

• Попросить менеджера обсудить с Вами проблему и исправить допущенные ошибки?

• Пересмотреть и проанализировать результаты, которые подверглись критике?


Практикум: Ответственность

11


• Аналитик готов к обмену опытом. Он проявляет

интерес не только к своим задачам, но и к задачам коллег.

• Аналитик может подменить коллегу, быстро

включается в новую задачу.

• Аналитик не перекладывает свою работу на плечи коллег (затягивая сроки, не заканчивая

работу перед отпуском или отказываясь от выполнения работы).


Компетенция: Умение работать в команде

12

Ситуация: Вы получаете довольно объемное задание за неделю до отпуска. Ваши действия?

• Отказаться от задания?

• Взять задание, но предупредить, что можете не успеть?

• Сделать, сколько успеете?

• Поторопиться, чтобы сделать все?

• Оценить, какой объем работы вы успеете сделать. Обсудить оценку с менеджером и договориться о сдвиге сроков или замене Вас на время отпуска?

• Отменить отпуск?


Практикум: Умение работать в команде

13


• Аналитик понимает, что результаты его работы

предназначены для других людей. Он думает о тех, кто будет читать его творение, будь то

коллега, начальник, заказчик или случайный посетитель корпоративного сайта.

• Аналитик уделяет внимание и содержанию и форме. Документы всегда аккуратно

оформлены, четко структурированы, безупречны с точки зрения стиля и правописания.


Компетенция: Внимательность и аккуратность

14

Русский язык нам всем родной. Современные текстовые редакторы предоставляют довольно развитые возможности

проверки орфографии и грамматики. И все-такивстречаются вот такие интересные примеры…


Знания: русский язык

15

Автоматическая проверка орфографии и грамматики –

хорошее средство против опечаток, но она не

освобождает от необходимости думать.

Приведен пример из документа с разметкой проверки грамматики MS Word. Найдите ошибки.


Практикум: анализ грамматики в MS Word

16

Не или Ни? Слитно или раздельно? Почему?


Практикум: некоторые случаи правописания частиц

17

Правило: Сочетания «не кто иной (другой), как» имеют

значение противопоставления, в них пишется отрицательная

частица не. Сочетания «никто иной (другой)» не связаны с

противопоставлением.

Ответы:


Практикум: некоторые случаи правописания частиц

18

Слитно или раздельно? Почему?


Практикум: некоторые случаи правописания союзов

19

Правило: Отличить союз «чтобы» местоимения с частицей «что

бы» можно, попробовав переставить «бы» в предложении. Союзы «тоже» и «также» употребляются в значении «и». В то время как «то же» и «так же» - для сравнения «так же, как».

Ответы:


Практикум: некоторые случаи правописания союзов

20

Приведены неверно или неудачно составленные предложения. Исправьте, объясните ошибки.


Практикум: согласование слов в предложении

1. Влажность воздуха составляет 76,5 процентов.

2. Машины стояли у обоих ворот.

3. До начала экзаменов осталось полтора учебного месяца.

21

Правило 1: При смешанном арифметическом числе

существительное управляется дробью, а не целым числом: 10,2 процента (а не «процентов»).

Ответы:



Правило 2: Так как нельзя сказать ни «оба ворота», ни «обе

ворота», то не может быть и сочетания «у обоих ворот». Следует сказать: у тех и других ворот или у одних и у других ворот.

Правило 3: При сочетании числительного полтора с

существительным определение ставится в форме множественного числа: полтора полных стакана.

22



Практикум: употребление местоимений

1. Мальчик теперь сирота; отец умер, когда ему было три года.

2. Группа сдала все зачеты и просила проэкзаменовать их в первую очередь.

3. Больной попросил сестру налить себе воды.

23

Правило 1: Местоимение обычно заменяет ближайшее к нему

предшествующее существительное. Нарушение этого положения ведет к искажению смысла.

Ответы:


Практикум: употребление местоимений

Правило 2: Собирательное существительное нельзя заменять

местоимением в форме множественного числа. Чтобы не создавать неудобное сочетание, следует собирательное слово заменить словом «студенты» или «учащиеся».

Правило 3: Возвратные местоимения себя и свой относятся к

лицу, производящему действие.

24




1. Ряд столов стояли посередине аудитории.

2. На совещание прибыли пятьдесят один делегат.

3. Отпущено миллион рублей на благоустройство поселка.

4. На экскурсию пошли всего десять школьников.

25

Правило 1: При подлежащем, выраженном именем

существительным собирательным (ряд, большинство, меньшинство, часть и т.п.) в сочетании с родительным падежом множественного числа, сказуемое обычно ставится во множественном числе, если речь идет о предметах одушевленных и в единственном числе, если подлежащее обозначает предметы неодушевленные.

Ответы:



Правило 2: При составных числительных, оканчивающихся

на один, сказуемое ставится в единственном числе

26

Ответы:



Правило 3: При словах тысяча, миллион, миллиард сказуемое

обычно ставится в единственном числе и согласуется в роде.

Правило 4: Если при счетном обороте имеются слова «все»,

«эти», то сказуемое ставится только во множественном числе. Наоборот, при наличии слов «всего», «только», «лишь» сказуемое ставится в единственном числе.

27

• Загляните в старые добрые учебники, купите сборник упражнений Розенталя, посетите ресурс www.gramota.ru

• Внимательно продумывайте предложения и перечитывайте документ перед отправкой результата. Обязательно пользуйтесь автоматической проверкой, но не полагайтесь на нее одну.

• Если возникают сомнения, лучше переформулируйте предложение. Разбейте на более простые части, используйте синонимы.


Как избежать ошибок?

28

• Вопросы?

• Перерыв 5 минут.


Перерыв 5 минут

29

Документы могут

• нести разное количество информации

• быть предназначены для людей различного уровня знаний

• предназначаться для изучения или использоваться как справочные материалы

К разным документам выдвигаются различные требования, связанные с его назначением и целевой аудиторией.

Но в чем отличия?


Назначение документа и целевая аудитория

Это определяет их объем

Это определяетих лексику

Это определяет структуру материала

30

Этапы анализа:

1. Определить цель составления текста

2. Определить соотношение объема передаваемой информации и времени, которое ей готов уделить читатель

3. Определить целевую аудиторию

Выделить характерные особенности • делового электронного письма, • художественного романа, • технической документации на ПО.


Практикум: Какими должны быть документы?

31


Итоги практикума: Какими должны быть документы?

Документ

ЭтапыE-mail Роман

Техническая документация

Цель, объем информации

Небольшой объем

Большой объемБольшой объем,

специализированная информация

Время читателя

Минимально возможное

Не ограниченоМинимально возможное

Целевая аудитория

Определенный человек или

несколько

Широкая аудитория

Широкая аудитория

Выводы

Краткое сообщение, лексика в

зависимости от адресата

Большой объем, художественны

й стиль, пространные рассуждения

Строгая структура, для минимального

времени поиска информации,

подробные пояснения

32

• Обязательно наличие содержания и структуры глав и секций для быстрого ориентирования. Проставляйте номера страниц;

• Разместите в начале документа список терминов и сокращений. Начните документ с раздела «Введение» или «Общая информация»;

• Перечисление элементов, шаги инструкций и т.п. оформляйте в виде списков. Если список сопровождается дополнительными свойствами элементов, требуется табличное представление;

• Не пренебрегайте ссылками. При работе с электронной версией документа они удобны.


Структура документа: простые приемы

33

• Узнайте о корпоративных традициях оформления документов. Если таковых нет, единожды сформируйте свою манеру оформления и убедитесь, что она не страдает при выводе на черно-белую печать;

• Некоторые рекомендации

• Выравнивайте абзацы по ширине, пользуйтесь красной строкой или делайте отступы между абзацами;

• Используйте шрифт по умолчанию: Times New Roman, 12pt;

• Выделяйте заголовки таблиц цветом фона или жирным шрифтом. Текст таблицы может быть выровнен влево или по центру. Размер шрифта в таблицах может быть уменьшен до 8 – 10pt.

• Используйте повсеместно одинаковое оформление, если иное не предписано постановкой задачи.


Оформление документа: разумный минимум

34

• Будьте внимательны к орфографии, синтаксису и стилистике;

• Избегайте сложных длинных предложений и заголовков. Чем сложнее излагаемый материал, тем проще должен быть язык;

• Все термины выносите в отдельную секцию и поясняйте;

• Не перегружайте документ аббревиатурами. По крайней мере, убедитесь, что при первом употреблении аббревиатуры вы приводите ее расшифровку, а лучше отдельно привести полный перечень используемых аббревиатур с расшифровкой;

• Сопровождайте текст рисунками и схемами. Именно сопровождайте, а не заменяйте одно другим. Только в сочетании они дают желаемый эффект


Язык документа: не разрушить впечатление

35

• Технические задания

• Сценарии использования и тестирования

• Пользовательские инструкции

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


Типы документов

36

ТЗ содержит

• основные технические требования;

• назначение, область применения;

• стадии разработки, состав, сроки исполнения и т. д.

ТЗ составляют на основе анализа результатов обследования, расчётов и моделирования

Техническое задание (Specification, technical standard) – это документ, описывающий требования,

которым должен соответствовать проектируемый и/или разрабатываемый продукт.


Техническое задание

37


Техническое задание и спецификация

Техническое задание Спецификация

Более наглядный, не содержащий технических

подробностей реализации документ, предназначенный для

заказчика

Более подробное и более техническое описание разрабатываемого продукта, предназначенное для архитектора и программистов

38

• 19.201-78. Техническое задание. Требования к содержанию и оформлению;

• 34.602-89. Техническое задание на создание автоматизированной системы;

• IEEE (Institute of Electrical and Electronics Engineers);

• SWEBOK (Software Engineering Body of Knowledge).

Инструкция по написанию – это ГОСТы и стандарты.


Как писать ТЗ? Стандарты и содержание

39

Задача: добавить пользователя в систему.

Сценарий использования:

1. Пользователь входит в систему в качестве администратора, переходит на страницу «Пользователи». Открывается список существующих в системе пользователей.

2. Пользователь нажимает на кнопку «Создать», открывается карточка, содержащая поля: Имя пользователя, логин, пароль.

3. Пользователь заполняет поля и нажимает кнопку OK. Система возвращается к списку пользователей, созданный пользователь отображается в списке. И т.д.

Сценарий использования содержит подробное описание действий пользователя и откликов системы, приводящих к

выполнению поставленной задачи


Сценарии использования

40


Сценарий тестирования:

1. Войти в систему под пользователем admin;

2. Выбрать в меню пункт «Пользователи». Открывается список существующих в системе пользователей.

3. Нажать на кнопку «Создать». Открывается карточка, содержащая поля: Имя пользователя, логин, пароль.

4. Ввести Имя «Иван Иванов», логин Ivanov, пароль 123456. Нажать OK. Система возвращается к списку пользователей

5. Убедиться, что пользователь Иванов появился в списке. И т.д.

Сценарии тестирования предназначены для проверки результатов разработки и схожи со сценариями использования


Сценарии тестирования

41


Фрагмент руководства администратора:

1. Выберите в меню пункт «Пользователи». Нажмите на

кнопку «Создать»; Приведен скрин-шот, кнопка «Создать» выделена яркой рамкой

2. Открывается карточка. Приведен скрин-шот.

3. Введите имя, логин, пароль и нажмите кнопку OK. И т.д.

Инструкция, поясняющая, как выполнить ту или иную операцию.


Пользовательская документация

42

MS Word

MS Excel

управление форматированием, работа с таблицами, списками,

стилями, примечаниями, ссылками составление содержания,

знакомство с работой в режиме track changes

MS Visio

Adobe Photoshop


Навыки владения инструментами

43

MS Word

MS Excel

управление форматированием, свойствами ячеек,

работа с формулами, сортировки,

фильтры, группировки,

сводная таблица (pivot-table) MS Visio

Adobe Photoshop



44

MS Word

MS Excel

MS Visio

Требования к MS Visio относятся в основном к

пониманию правил и/или стандартов нескольких типов схем:

UML, Windows XP User Interface

и некоторых других.

Adobe Photoshop



45

MS Word

MS Excel

MS Visio

Adobe Photoshop

Достаточно поверхностного знакомства в качестве вспомогательного

средства для подготовкииллюстраций.



46

Введение | Подведем итоги

Техническийписатель

КомпетеницииСамостоятельность

Ответственность

КомандаАккуратность

Типыдокументов

Знания Русский языкстилистика,

правописание

Офисные инструмент

ы

Основы составления документов

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

Функции технического писателя в работе аналитика

Business