Есть ли хороший пример хорошего руководства пользователя?

Question

Я пытаюсь создать руководство пользователя на основе настольного приложения vb6, его должны использовать в основном нетехнические люди о том, как использовать программное обеспечение, и я также нуждаюсь в нем, чтобы показать клиентам, что они покупают, Что ж.

Я видел это previous discussion on best-practice, но я ищу надежное полезное руководство пользователя для реальных продуктов, чтобы я мог лучше понять, что писать или включать. он не обязательно должен быть настольным приложением или основанным на vb6, я просто пытаюсь найти какие-то вдохновения.

спасибо.

Answer 1

Серия «Манекены для ...» хорошо зарекомендовала себя, как и некоторые другие.

Лучший совет, который я когда-либо получал в этой области, был Знай свою аудиторию - и напишите на их нужды.

Не записывайте руководство, в котором вы нуждаетесь. Напишите то, что нужно конечным пользователям.

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

Подсказка: их цель состоит не в использовании вашего программного обеспечения, а в том, чтобы выполнить свою работу - писать небольшими кусками и показывать пользователям, как ваше программное обеспечение может облегчить жизнь.

Реальный пример из жизни:

Одним из результатов на несколько моих последних проектов был Support Guide - подробная информация для справочной службы и инфраструктуры, все о том, как ухаживать за системой.

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

Я сломал документ на 3 ключевых раздела: Развертывание, симптомы и решения.

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

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

Решения перечислены различные процедуры, как проверить конфигурацию, проверить работу, изолировать проблемы и т. Д.

Документ является очень повторяющимся - так что конечным пользователям не нужно нырять с места на место, чтобы найти то, что им нужно.

Эта структура очень сильно отличается от моих первых черновиков, но оказалась полезной.

Answer 2

Золотой стандарт для документации конечного пользователя для потребителей традиционно был Quickbooks - вы можете начать с обзора этого приложения.

Если это закрытая аудитория, и у вас есть пользовательские истории, которые вы использовали для дизайна, то это тоже будет хорошей ставкой.

Answer 3

Это, вероятно, путь от левого поля, но Musician's Manuals that Ensoniq provided for their synthesizors всегда хорошо смотрелись. Вы можете начать с самого начала и постоянно работать со своим путем, изучая все о машине в разумном порядке, а затем вы позже вернетесь в ту же книгу и используйте ее в качестве справочного руководства, не запутавшись в «учебнике», его аспекте.

Answer 4

Я помню, что был очень впечатлен ясностью и качеством руководств (как руководства пользователя, так и справочного руководства) калькулятора HP28S. С ними было очень легко учиться, понимать и осваивать сложность устройства и никогда не чувствовать потери от ненужных осложнений.