Письмо Полезной Помощи - Контрольный список Минимализма

Пользовательская документация слишком часто пишется программистами для программистов. Это имеет тенденцию сосредотачиваться на особенностях продукта, а не задачах пользователя. Вообще, программисты не находятся в идеальном положении, чтобы написать пользовательскую документацию. Они слишком близко к битам и байтам, и они слишком далеки от пользователя. К ним то, что может сделать продукт, имеет тенденцию быть намного более важным чем, что пользователь может сделать с продуктом.

Это - тонкое - но жизненный - различие. Исследование показывает, что ключ к эффективной пользовательской документации - ориентируемая помощь задачи записи. Еще лучше, напишите свою помощь согласно теории приверженца минимализма. В мире документации, minimalism причудливое слово для практики здравого смысла. В основных условиях это означает, пишут Вашему читателю и держат это простым.

У самой теории есть много завихрений и поворотов. Если Вы хотите прочитать великое - но немного многословный - заказывают на предмете, проверяют книгу Минимализм Вне Nurnberg Funnel, 1998, отредактированный Джоном Carroll.

Тем временем, если Вы можете пометить каждый пункт в следующем контрольном списке, Вы будете хорошо на Вашем пути к помощи онлайн годной к употреблению, за которую будут благодарить Вас и Ваши читатели и Ваши менеджеры.

Полезный Контрольный список Помощи

1. Базируйте помощь на реальных задачах (или реалистические примеры)

2. Структурируйте помощь, основанную на последовательности задачи - заголовки Главы должны быть целями, и темы должны быть задачами

3. Уважайте деятельность читателя - это вообще больше, о каком Вы не делаете чем, что Вы делаете. Не тратьте впустую время читателя, ныряя прочь в тангенсы

4. Эксплуатируйте предшествующее знание, и опыт - Привлекают внимание читателя к предыдущим задачам, событиям, успехам, и отказам

5. Предотвратите ошибки - "Гарантируют, что Вы делаете x прежде, чем сделать y"

6. Обнаружьте и идентифицируйте ошибки - "Если это терпит неудачу, Вы, возможно, вошли в путь неправильно"

7. Ошибки затруднительного положения - "Повторно вводят путь"

8. Обеспечьте ошибочную информацию в конце задач, где необходимый (эмпирическое правило, одно ошибочное примечание информации в три задачи - хорошее среднее число)

9. Не разбивайте инструкции с примечаниями, предостережениями, предупреждениями, и исключительными случаями - Помещенный эти вещи в конце инструкции, везде, где возможно

10. Будьте кратки, не обстоятельно объясняйте все, особенно вещи, которые могут считаться

11. Опустите концептуальный и отметьте информацию где только возможно, или свяжитесь с нею. Возможно предоставьте информацию расширения в конце темы, плюс возможно примечание, что есть другие способы выполнить задачу/цель, но это является самым легким

12. Секции должны выглядеть короткими и читать короткий

13. Обеспечьте закрытие для секций (e. г., назад к оригинальному экрану/цели)

14. Обеспечьте непосредственную возможность действовать и поощрить исследование, и новшество (используйте активные приглашения, чтобы действовать, такой как, "Лично убедитесь...", или "Пробуют это...", а не пассивные приглашения такой как, "Вы можете...")

15. Начните пользователей быстро

16. Учтите чтение в любом заказе - делают каждую секцию модульной, особенно цели, но возможно задачи (определенно, если они могут быть выполнены в различном заказе)

17. Вещи основного момента, которые не типичны

18. Используйте действительный залог, а не страдательный залог

19. Попытайтесь составлять окружающую среду пользователя в Вашем письме

20. Прежде, чем написать что-нибудь, спросите себя это поможет моему читателю?

Встраивая эти методы в Ваш процесс документации, Вы найдете, что Ваша помощь онлайн становится легче написать, короче, и намного более годный к употреблению для Вашего читателя. К тому же, Ваш босс будет любить Вас!