Написання технічного посібника - це найпростіше завдання, яке включає в себе організацію кроків і створення чіткої, стислої формули. Метою технічного посібника є надання інформації про те, як виконати операцію в найменшій кількості кроків і ясним чином. Технічні посібники часто передбачають співпрацю з багатьма людьми, включаючи експертів з предметів, редакторів та технічних авторів. Оскільки технічні посібники також можуть постійно переглядатися та оновлюватися, комунікація між залученими сторонами має вирішальне значення для розробки посібника.
Визначте стиль технічного посібника, створюючи спрощений посібник щодо стилю або дотримуючись існуючого керівництва по стилю, наприклад, Керівництво по стилю Microsoft для технічних посібників. Стильний посібник допоможе створити скелет керівництва та забезпечить узгодженість.
Напишіть кроки для процедури, починаючи з дієслова. Якщо потрібні консультації, щоб написати кроки, провести співбесіду і задати питання експертам з предмету. Це забезпечить достовірність процедур; в іншому випадку дії не можуть бути логічними та / або невідповідними. Етапи повинні бути логічно впорядковані та розділені на логічні розділи або розділи.
Додайте графіки та ілюстрації до кроків, які їх потребують. Не забудьте додати нумерацію цифр і заголовки для кожної графіки / ілюстрації.
Створіть зміст та індекс для зручності.
Додайте журнал змін або аркуш оновлень, який записує кожну зміну і оновлює посібник для майбутніх редагувань і випусків. Технічні посібники завжди повинні редагуватися іншим, ніж технічним автором, бажано професійним редактором.
