Есть ли хороший пример полезного руководства пользователя?
Я пытаюсь создать руководство пользователя для настольного приложения vb6, оно должно использоваться в основном не техническими специалистами о том, как использовать программное обеспечение, и мне также нужно, чтобы оно показывало клиентам, что они покупают.
Я видел это предыдущее обсуждение наилучшей практики, но я ищу полезное руководство пользователя для реальных продуктов, чтобы я мог лучше понять, что написать или включить. это не обязательно должно быть настольное приложение или основанное на vb6, я просто пытаюсь найти вдохновение.
Благодарю.
4 ответа
Серия "Путеводитель по чайникам..." хорошо зарекомендовала себя, как и некоторые другие.
Лучший совет, который я когда-либо получал в этой области, был " Знай свою аудиторию" - и напиши для них.
Не пишите руководство, которое вам нужно. Напишите, что нужно конечным пользователям.
Поставьте себя на их место и подумайте о своих целях. Подумайте о ситуациях, в которых они будут находиться, и о том, что им нужно - и предоставьте это.
Подсказка: их цель не в том, чтобы использовать ваше программное обеспечение, а в том, чтобы выполнить свою работу - писать небольшими порциями и показывать пользователям, как ваше программное обеспечение может облегчить им жизнь.
Пример из реальной жизни:
Одним из результатов нескольких моих недавних проектов было Руководство по поддержке - подробная информация о службе поддержки и инфраструктуре, а также о том, как ухаживать за системой.
Повествовательный стиль бесполезен для этих руководств поддержки - потому что никто никогда не сядет и не прочтет его. Занятые люди просто не успевают.
Я разбил документ на 3 ключевых раздела: развертывание, симптомы и решения.
Развертывание показывает, как система должна быть развернута - какая часть на каком компьютере, как они взаимодействуют (вплоть до номеров портов) и где найти файлы конфигурации и журналов.
Симптомы перечислены различные способы, которыми пользователи могут заметить, что система не работает должным образом. Это настроено так, что они могут просто просмотреть жалобу пользователя и получить некоторые рекомендации. Под каждым симптомом приведен список решений, которые нужно попробовать.
Решения перечисляют различные процедуры, как проверить конфигурацию, проверить работу, изолировать проблемы и так далее.
Документ очень повторяющийся - так что конечным пользователям не нужно нырять с места на место, чтобы найти то, что им нужно.
Эта структура очень сильно отличается от моих первых проектов, но оказалась полезной.
Золотым стандартом для документации для конечных пользователей традиционно были Quickbooks - вы можете начать с обзора этого приложения.
Если это закрытая аудитория, и у вас есть пользовательские истории, которые вы использовали для дизайна, то это было бы неплохо.
Я помню, что был очень впечатлен ясностью и качеством руководств (как руководства пользователя, так и справочного руководства) калькулятора HP28S. С ними было очень легко выучить, понять и освоить сложность устройства и никогда не чувствовать себя потерянным из-за ненужных осложнений.
Это, вероятно, далеко от левого поля, но Руководства Музыканта, которые Ensoniq предоставил для своих синтезаторов, всегда были в почете. Вы могли бы начать с самого начала и постепенно проработать свой путь, изучая все о машине в разумном порядке, а затем вы позже вернетесь к той же книге и будете использовать ее в качестве справочного руководства, не запутываясь в "учебнике". аспект этого.