Як написати керівництво
На перший погляд, написати керівництво - справа складна. На другий погляд все, як не дивно, куди простіше. Прочитайте цю статтю і дізнаєтеся, як написати будь-яку інструкцію, від простої до складної!
Кроки
Метод 1 з 4: Вивчіть тему
1
І в цьому вся сіль. Так, звучить очевидно, але знання - ключ до успішного написання керівництва. Ви повинні знати предмет якщо не у всіх-всіх, то хоча б у багатьох тонкощах. Чим краще і глибше ви знаєте предмет, тим простіше вам буде пояснити незнайомому з ним людині що завгодно.
2
Проконсультуйтеся з експертами. Якщо ваше завдання - просто написати, а не виступити в якості експерта, то й писати доведеться "під диктовку", звіряючись з експертами і даючи їм перевірити написане. Знання та поради від знаючих людей безцінні.
3
Використовуйте практичний підхід. Спробуйте і самі зробити те, про що пишете, і ви зрозумієте, про що захочеться дізнатися вашому читачеві і з`ясувати.
4
Почитайте більше тематичних джерел. Прочитайте те, що вже написано по темі вашого керівництва - це буде тільки на користь.- Аналогічні керівництва допоможуть зрозуміти, про що і як треба писати.
- Аналізуйте прочитане, шукайте спільні риси до опису особливостей і функціоналу.
- За аналогією поступайте з відмінностями. Так ви зумієте описати унікальні функції свого товару або продукту. Чим більше інформації в керівництві, тим краще і тим більше ймовірність, що читач буде зацікавлений нею і дочитає її до кінця.
- Аналогічні керівництва допоможуть зрозуміти, про що і як треба писати.
5
Читайте тематичні журнали. Дізнайтеся, як користуються тим чи іншим інструментом люди, яким він необхідний у повсякденній практиці. Може, виходячи з цього слід приділити більше уваги який-небудь особливості вашого продукту.
Метод 2 з 4: Напишіть загальний план
1
- Розкладіть все по пунктах. Перш ніж писати будь-яке керівництво, яким би воно не було, треба скласти його план.
2
Користь зрозуміла - можна приділити увагу всім потрібним аспектам. А адже ваша мета полягає саме в тому, щоб познайомити користувача з процесом - нехай навіть і в загальних рисах. А те, як виконується яке-небудь конкретне дію, можна перенести в кінець керівництва, або ж і зовсім не згадувати.
3
Дотримуйтесь логічну послідовність. Ця порада особливо корисний, якщо ви самі не дуже добре розбираєтеся в темі. Самі посудіть, говорити про спалах фотокамери варто вже після того, як ви поясните, як вставити лінзи, зарядити плівку, налаштувати фокус і все таке.
4
Візьміть цей шаблон за основу змісту керівництва.
5
Прочитайте всі і перевірте. Переконайтеся, що ніщо не відходить від обраної вами схеми розповіді.
6
Візьміть те, до чого пишете керівництво. Нехай цей предмет буде у вас під рукою - вам потрібно буде, перевірки заради, скористатися ним строго по написаному собою керівництву.
Метод 3 з 4: Почніть писати
1
Напишіть введення. Це задасть тон всьому керівництву і покаже читачеві, що його чекає. А те, яким має бути вступ, залежить від вашого читача. Зрозуміло, що інструкція про те, як зробити листівку до дня народження буде злегка відрізнятися від "інструкції" щодо проведення операції на відкритому серці. Виберіть стиль оповіді і не відходьте від нього.- Виконайте всі дії, паралельно записуючи все. Так не тільки буде чесно, але ще й ви самі нічого не пропустите.
2
Якщо такої можливості немає, то обов`язково проконсультуйтеся в кінці з експертом.- Пронумеруйте дії. З нумерованим списком людям працювати простіше, це факт.
3
Якщо ви пишете на папері, залишайте між рядками достатньо місця, щоб виставити ще лінію-другу. І не забудьте зрушити нумерацію, якщо що.- Напишіть поради та попередження. У процесі роботи над керівництвом вас може відвідати думка про те, що без належної старанності виконання тієї або іншої дії користувачем може призвести до проблеми.
4
Плюс якщо у вас є в пам`яті цікавий факт, яким буде корисно поділитися з читачем - напишіть і його.- Перевірте всі. Отже, у вас є інструкція - тепер зробіть потрібну дію строго по вашому керівництву. Якщо ви знайдете місця, де ваше керівництво незрозуміло, неадекватно, неточно і т.д. - Виправте все як треба. Повторюйте цей етап до тих пір, поки ваше керівництво не стане повним.
5
Корисно буде дати почитати керівництву одного і подивитися, чи допоможе воно їм. Слідкуйте за їхньою реакцією і потім внесіть в керівництво потрібні зміни.
6
Відредагуйте керівництво. Перевірте граматику, орфографію, пунктуацію. Ви ж не хочете здати роботу з помилками?
Метод 4 з 4: Форматування
1
- Почніть з верхнього рівня. А верхній рівень - це заголовки. Закінчивши всі вище перелічені пункти, перечитайте керівництво і знайдіть у ньому майбутні заголовки майбутніх розділів.
2
Дайте їм назву і запам`ятайте, на якій вони рядку знаходяться.
3
Якщо потрібно, зробіть зміст. Згодиться звичайне ієрархічне зміст, тобто головна сторінка і кілька підзаголовків з субкатегорій і так далі. Чим більше опрацьовану і докладний посібник ви написали, тим більше розділів і підрозділів вам знадобиться.- Відредагуйте все ще раз. Так, саме. Ще раз. Вдруге ви, поза всяким сумнівом, побачите ті помилки, які пропустили в перший раз.
4
У випадку більш докладного керівництва це також дасть вам можливість виділити невеликі теми та внести їх у зміст.
Поради
- По можливості, ілюструє своє керівництво. Якщо зображення вставляти не можна, робіть відсилання до поширених прикладів.
- Якщо є можливість, дайте новачкові покористуватися пристроєм, а потім запишіть всі поставлені їм запитання. Це допоможе зробити керівництво корисніше і повніше.
- Навіть якщо щось здається вам очевидним, про це все одно треба писати. Краще написати більше, ніж менше.
- Якщо ви пишіть дуже докладний посібник, де потрібно написати цілі глави - то почніть з змісту. І пам`ятайте, що до глав застосовні ті ж самі базові вимоги, бо що таке глава, що не міні-керівництво?
- Кожен розділ пишіть на окремій сторінці, так буде простіше їх, якщо що, поміняти місцями, внести виправлення і так далі. На комп`ютері це особливо просто.
