/
levels_technical_writer.rst
108 lines (57 loc) · 16.5 KB
/
levels_technical_writer.rst
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
Уровни
======
Технический писатель (Junior)
-----------------------------
**Технический писатель (Junior)** -- это начинающий специалист в области технического письма, который обладает определенными знаниями и навыками, хотя его опыт работы может быть ограничен. Вот подробнее о знаниях и навыках, которые можно ожидать от технического писателя на уровне Junior:
- **Коммуникационные навыки**: У технического писателя на уровне Junior должна быть способность хорошо коммуницировать с разными аудиториями. Он должен быть в состоянии понять техническую информацию и представить ее в понятной и доступной форме для читателей.
- **Базовые знания технической терминологии**: На уровне Junior ожидается, что технический писатель имеет базовые знания и понимание терминологии в области, с которой он работает (например, программирование, инженерия, медицина и т. д.).
- **Понимание структуры документации**: Технический писатель должен знать основные принципы структурирования технической документации, такие как создание заголовков, списков, таблиц, оглавлений и т. д.
- **Основы технического редактирования**: Технический писатель на уровне Junior должен быть знаком с базовыми принципами редактирования и корректуры текста, чтобы обеспечить точность и ясность документации.
- **Использование инструментов для разработки технической документации**: На уровне Junior технический писатель может быть ознакомлен с инструментами для создания и форматирования документации, такими как Microsoft Word, Google Docs, или другие инструменты для разработки технической документации.
- **Основы стиля и форматирования**: Технический писатель должен знать основы стиля и форматирования, которые приняты для разработки технической документации. Это включает использование списков, шрифтов, заголовков и других элементов для лучшего понимания документации.
- **Обучаемость и стремление к саморазвитию**: На уровне Junior ожидается, что технический писатель будет стремиться к улучшению своих навыков и готов учиться от более опытных коллег.
Уровень Junior предполагает относительно небольшой опыт, ожидания и требования для этого уровня могут отличаться в разных организациях. Технический писатель на уровне Junior обычно работает под руководством более опытных коллег, что позволяет ему получить ценный опыт и совершенствоваться в своей профессиональной области.
Технический писатель (Intermediate)
------------------------------------
**Технический писатель (Intermediate)** -- это специалист с опытом работы, который может самостоятельно решать задачи по созданию и поддержанию технической документации. Он имеет более глубокое понимание области и демонстрирует более высокий уровень навыков. Вот некоторые характеристики Intermediate-уровня:
- **Углубленные знания технической терминологии**: На уровне Intermediate технический писатель должен обладать более глубоким пониманием специфической терминологии и технических концепций в своей области.
- **Опыт работы с различными типами документов**: Технический писатель на Intermediate-уровне может работать с разнообразными типами документов, такими как руководства пользователя, технические спецификации, API-документация, релизные заметки и т. д.
- **Знание стандартов документации**: Опытный технический писатель будет знать и применять стандарты и рекомендации по созданию и форматированию технической документации, чтобы обеспечить ее согласованность и качество.
- **Навыки совместной работы**: На уровне Intermediate технический писатель может успешно сотрудничать с различными командами, включая разработчиков, инженеров, менеджеров продукта и других специалистов.
Технический писатель (Senior)
-----------------------------
**Технический писатель (Senior)** -- это специалист с богатым опытом и экспертизой в области технической документации. Он может руководить процессом создания документации, разрабатывать стандарты и процедуры, а также работать с более сложными проектами. Ниже приведены некоторые характеристики Senior-уровня:
- **Большой опыт и экспертиза**: Обширный опыт работы и глубокие знания в своей области, способность ориентироваться в сложных технических темах.
- **Лидерство и руководство**: Умение руководить группой технических писателей, разрабатывать стратегии документирования, управлять проектами и обучать новых сотрудников.
- **Разработка стандартов**: Создание стандартов и процедур для документации, обеспечение согласованности и высокого качества.
- **Взаимодействие с различными аудиториями**: Успешное взаимодействие с разными группами пользователей, предоставление соответствующей информации.
- **Глубокое понимание продуктов/технологий**: Хорошее понимание продуктов или технологий, предоставление сложной информации простым языком.
- **Составление API-документации**: Опыт составления API-документации, включая описание функций, параметров и примеров использования.
- **Работа с различными инструментами**: Опыт работы с различными инструментами технической документации.
- **Стилистика и редактирование**: Отличные навыки стилистики и редактирования текста.
- **Консультационные и образовательные навыки**: Консультирование и обучение других команд по вопросам документирования.
Технический писатель на уровне Senior является ключевой фигурой в области технической коммуникации и играет важную роль в успешной доставке информации о продуктах или услугах компании ее клиентам и пользователям. Он имеет высокий уровень ответственности и требует отличных навыков руководства, коммуникации и технической экспертизы.
Технический писатель (Lead)
----------------------------
**Технический писатель (Lead)** -- это руководящий уровень для технических писателей. Технический писатель-лидер может руководить группой технических писателей, определять стратегию документирования, взаимодействовать с другими отделами, управлять проектами и координировать работу команды.
- **Управленческие навыки**: Технический писатель (Lead) обладает навыками управления проектами, ресурсами и людьми. Он умеет устанавливать приоритеты и эффективно организовывать работу команды технических писателей.
- **Стратегическое планирование**: Технический писатель (Lead) разрабатывает стратегические планы по развитию документации, определяет направления работы и принимает решения, способствующие успеху проектов.
- **Управление качеством**: Технический писатель (Lead) отвечает за обеспечение высокого качества технической документации. Он устанавливает стандарты контроля качества, проводит рецензии и аудиты документации.
- **Менторство и обучение**: Технический писатель (Lead) руководит процессом обучения и менторства для новых членов команды. Он поддерживает развитие навыков и профессионального роста своих подчиненных.
- **Взаимодействие с клиентами**: Технический писатель (Lead) может взаимодействовать с клиентами или пользователями, чтобы получить обратную связь о документации и удовлетворить потребности аудитории.
- **Опыт работы с разными типами документов**: Технический писатель (Lead) имеет опыт работы с различными типами документов, включая руководства пользователя, технические спецификации, API-документацию, релизные заметки и т. д.
- **Стремление к совершенствованию**: Технический писатель (Lead) всегда ищет способы улучшения процессов создания документации, внедрения инноваций и применения передовых практик.
Роль Технического писателя (Lead) предполагает более высокий уровень ответственности и сложности задач по сравнению с более низкими уровнями, а также требует умения эффективно руководить командой и управлять проектами.
Технический писатель (Manager/Director)
---------------------------------------
**Технический писатель (Manager/Director)** -- это уровень управления отделом технической документации. Он отвечает за стратегическое планирование, бюджетирование, найм и управление персоналом, а также за обеспечение высокого качества документации во всей организации.
- **Управленческие навыки**: Опыт управления отделом или командой технических писателей, найм, обучение, установление целей и оценка производительности.
- **Стратегическое планирование**: Разработка стратегий развития документации, приоритизация задач и решение сложных вопросов в области технической коммуникации.
- **Управление бюджетом**: Бюджетирование и распределение ресурсов отдела документации, эффективное управление затратами.
- **Взаимодействие с высшим руководством**: Представление отдела документации на высшем уровне компании, общение с топ-менеджментом и руководителями других отделов.
- **Управление проектами**: Руководство крупными проектами по созданию и обновлению документации, управление ресурсами, сроками и рисками.
- **Улучшение процессов**: Постоянное стремление к улучшению процессов создания и управления документацией, внедрение передовых методов и инструментов.
- **Развитие персонала**: Поддержка профессионального развития сотрудников, обучение, менторство и стимулирование карьерного роста.
- **Качество документации**: Обеспечение высокого стандарта качества документации во всей компании, точность, ясность и полнота информации для клиентов и пользователей.
- **Стратегическое видение**: Определение роли технической документации в организации и ее вклада в достижение бизнес-целей компании.
Роль Технического писателя (Manager/Director) предполагает высокий уровень ответственности за документацию в организации и требует широкого кругозора в области управления, стратегического планирования и развития персонала.