От автора ....................................................... 6
Глава 1. Введение в специальность, или Рыцари клавиатуры ........ 8
1 Кто работает с текстами? ................................. 10
2 Особенности работы технического писателя ................. 17
3 Отличие «технического» писателя от «классического» ....... 24
4 Почему навыки работы с текстами нужны всем? .............. 26
5 Почему инженер или программист не может писать
технические тексты? ...................................... 30
6 Профессия технического писателя в РФ и за рубежом ........ 33
7 Технический писатель и прогресс - заменят ли нас
программы? ............................................... 36
Глава 2. Как стать техническим писателем ....................... 40
1 Как определить, подойдёт ли мне эта профессия и что тут
нужно уметь? ............................................. 40
2 Несколько хитростей для успешного выполнения тестового
задания .................................................. 46
Глава 3. Юридические аспекты работы ............................ 51
1 Варианты занятости технического писателя ................. 51
2 Территориальные варианты занятости. Офис и удалённая
работа ................................................... 59
3 Формирование портфолио специалиста по текстам ............ 65
Глава 4. Производственные процессы ............................. 68
1 При работе по найму ...................................... 68
2 При работе на подряде и фрилансе ......................... 73
3 Методика переговоров со специалистами, получение и
анализ сведений .......................................... 75
Глава 5. Приступая к работе: базовые сведения и понятия ........ 78
1 Области, в которых присутствует работа с текстами ........ 78
2 Классификация носителей информации ....................... 78
3 Типы пользователей документации .......................... 86
4 Основные группы пользователей документации ............... 91
Глава 6. Формат документа и статьи ............................. 99
1 Формат и структура технического документа ................ 99
2 Формат и структура статьи. Канон и отступления от него .. 101
Глава 7. Основы создания технической документации ............. 106
Глава 8. Базовые приёмы работы с текстом ...................... 114
1 Лексические тонкости и основные ошибки в технических
документах .............................................. 114
2 Оценка объёма текста и графики при создании
документации ............................................ 119
3 Оценка времени, необходимого на разработку
технического документа .................................. 122
4 Методология определения конечных сроков выполнения
работы и контроль их соблюдения ......................... 127
5 Контроль оригинальности текстов ......................... 131
6 Корректировка и редактирование технических текстов ...... 134
Глава 9. Применяемое программное обеспечение .................. 139
1 Платное и бесплатное программное обеспечение ............ 139
2 Microsoft Office и альтернативы ......................... 140
3 Важные возможности Microsoft Word ....................... 141
4 Приложения для совместной работы ........................ 150
5 Инструменты для создания видеоинструкций ................ 151
Глава 10. Обзор дополнительных областей ....................... 152
1 ГОСТы и иные мировые стандарты документирования ......... 152
2 Документирование API .................................... 154
Полезные ссылки и материалы ................................... 156
|