Якщо вам було доручено написати документ, який повинен доручити комусь іншому, як щось робити, сьогоднішній спосіб зробити це більш-менш викидає старі методи у вікно.
1. Великі бомбастичні заголовки
Ви помітите, що заголовки в PCMech, такі як той, що знаходиться вище цього речення, величезні. Це тому, що вони легше бачити, читати та знати, де ви знаходитесь у документі.
2. Менше слів
Неправильний шлях:
Наступна документація пояснює, як використовувати та керувати Fanny Whacker 2000.
Правильний шлях:
Інструкції щодо використання Fanny Whacker 2000
Завжди пам’ятайте цю фразу, коли пишуть документацію: ПОДІЙТЕ ДО ТОЧКА ТАКІ ШВИДКО ТА МОЖЛИВО.
3. Пропустіть марні посилання
Якщо посилання не має нічого спільного з основною інструкцією того, що ви намагаєтесь описати, наприклад:
Для отримання додаткової інформації про паяння реп'яху Fanny Whacker 2000, будь ласка, дивіться документ FU, підрозділ ID10T.
… Не робіть цього.
4. Датуйте його. Завжди.
Дата написання документації повинна бути в області нижнього колонтитулу кожної сторінки. Якщо це електронний документ, дата відображається двічі. Раз на початку, раз у кінці.
Ви можете написати це як "Останнє оновлення (тут вставте дату)".
5. Попередження завжди повинні бути розміщені до місця неповернення
Якщо у вашій документації є щось, що могло б щось пошкодити / знищити / видалити, якщо воно буде виконано неправильно, цю інформацію слід розмістити безпосередньо після зазначеної інструкції, бути в очах (мається на увазі на тій же сторінці) та акцентовано.
Приклад:
Крок 5. Очищення Fanny Whacker 2000
Весла FW2000 слід обережно очистити, використовуючи неабразивну м’яку тканину.
УВАГА: Використовуйте лише розчинник, що не містить аміаку, щоб запобігти вибуху FW2000 і призведе до несвоєчасної смерті.
Насамкінець, хороша документація - це не надто описовий опис кожної можливої речі, яку можна уявити. Прочитайте свою документацію і запитайте себе, чи правильно вона вказує? Якщо відповідь "так", наступне питання: чи це інструктаж швидко ? Якщо так, документація хороша.
