Технічна документація
Ми пропонуємо прослухати курс по роботі з документацією і написанню користувацьких інструкцій для початківців технічних письменників, а також для бажаючих познайомитися з професією технічного письменника і навчитися основам розробки технічної документації.
Після проходження базового курсу слухач буде
знати:
- Хто такий технічний письменник: кваліфікація та обов’язки.
- Що таке документація користувача: види і категорії.
- Як організувати робочий процес розробки документації.
- Які існують етапи розробки документації.
- Які основні принципи і методи складання технічної документації.
- Які правила, обмеження і рекомендації використовуються при оформленні документації.
- Які стандарти застосовуються при розробці технічної документації.
вміти:
- Визначати вимоги до документації і формулювати постановку задачі.
- З’ясовувати тип необхідної інформації для розробки документації і виявляти відповідні джерела інформації.
- Використовувати інформацію про цільову аудиторію і функціональності програми з метою подальшого аналізу та виявлення ролей користувачів.
- Складати структуру документа, використовуючи інформацію про узагальнену структуру документа і види розділів документів.
- Розробляти інструкції, виходячи з попередньо підготовленої структури документа.
- Знаходити і виправляти помилки в документі, грунтуючись на знаннях про стилі та форматування документа.