Каков наилучший подход к созданию руководств пользователя?

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

Кто занимается техническим письмом и как это делается?

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

1. Попросите технического персонала написать руководство пользователя.

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

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

В конце концов, зачем нанимать и платить дополнительному сотруднику, когда лучшие ресурсы уже есть? Это не лучшая идея и не самая экономичная. Хотя технический персонал является одним из источников руководства, он не обязательно является лучшим человеком для создания учебного пособия. Вот почему:

Прежде всего, хорошие ли они писатели? Многие технические специалисты, чья основная работа заключается в проектировании и разработке продукта, не заинтересованы в написании и документировании; по той же причине они не занимались писательством профессионально. Они могут думать, что у них есть другие неотложные дела, и это правда, учитывая их основные задачи и обязанности. Следовательно, они могут не быть умелыми писателями и не желать приобретать эти навыки. Однако, если ваши технические специалисты являются хорошими писателями или интересуются писательством, вам повезло. Но это еще не все.

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

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

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

Советы по использованию этого метода:

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

2. Попросите технического персонала написать руководство и поручите его корректуре редактору/писателю.

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

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

Советы, как получить максимальную пользу от этого метода:

• Хорошее сотрудничество может привести к созданию профессионала. Убедитесь, что вы связали экспертов в данной области (вашу техническую команду) с автором/редактором, а не просто просите случайных авторов редактировать документ без какой-либо дополнительной информации.
• Убедитесь, что автор может часто возвращаться к технической команде, чтобы обсудить различные детали или когда возникают вопросы. А также попросите техническую команду просмотреть отредактированный документ, чтобы убедиться, что технический контент воспринимается и передается правильно.

3. Поручите техническому писателю выполнить работу в тесном сотрудничестве с технической командой.

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

Совместное письмо — это волшебный трюк.

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

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

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

Узнайте больше о функциях совместной работы Sonat здесь .