Привет!
Любите ли вы читать справочные книги? А как насчет письма? Я думаю, что 99% из вас ответят «НЕТ».
Но от создания сертификата никуда не деться, потому что помощь — обязательное средство связи с пользователем .
И чтобы создание помощи не оказалось чем-то сложным, неуправляемым и непонятным, необходимо выстроить четкий и отлаженный процесс.
В этой статье я хотел бы поделиться наш опыт и описать процесс справочной документации, которую мы используем в Алконост .
Роли
Для начала давайте определим типичные роли в проекте.Обычно в создании сертификата участвуют:
- Разработчик (программист или менеджер продукта);
- Технический писатель;
- Руководитель проекта.
В идеальном случае (в крупных компаниях так и есть) все эти роли представляют отдельные сотрудники, но в суровой реальности все эти шляпы может носить один человек одновременно.
Чтобы работа над справочной документацией (а это не только создание, но и дальнейшая поддержка и развитие) не замедляла процесс разработки, следует разделить роли разработчика и технического писателя.
Сами против аутсорсинга
Если у вас крупная компания, много продуктов и 100% загруженность техническим писателем, оптимально будет найти или обучить технического писателя.Следует отметить, что технический писатель – довольно редкая профессия; у этих людей всегда много хорошей работы, и они редко ее ищут, т. е.
отделу кадров придется работать больше.
Альтернативный вариант — передать создание справочной документации на аутсорсинг.
В этой модели за разработчиком сохраняется только своя роль.
А руководителя проекта по созданию и поддержке справочной документации, технического задания, редакторов и переводчиков предоставляет подрядчик.
Поскольку подрядчик выполняет справочную работу для многих клиентов, его технические писатели всегда заняты и имеют ресурсы и интерес для обучения новых.
Также стоит упомянуть инструменты для создания справки.
Не всегда разработчику оправдано приобретение программных комплексов для создания справочной документации.
Если у вас небольшая утилита и вам нужно только начать работу, не стоит покупать дорогое программное обеспечение.
Аутсорсинговая помощь в разработке полезна по другой причине.
Внешние технические писатели могут найти ошибки, посоветовать разработчику некоторые улучшения интерфейса или предложить свои идеи по развитию программы.
Этот пристальный (а технический писатель изучает программу глубже, чем рядовой пользователь) «взгляд со стороны» никогда не будет лишним.
Разработку нормативной документации можно считать дополнительным этапом обеспечения качества.
Требования к результату
Итак, перейдем к делу.Неважно, будете ли вы оказывать помощь самостоятельно или с помощью аутсорсера, на первом этапе вам понадобится четкое представление о том, что вам на самом деле нужно.
Помощь может быть разной, об этом я писал в предыдущей статье Виды и форматы сертификатов (инфографика) - выберите то, что вы хотите в качестве конечного результата.
Процесс
Проекты помощи в разработке обычно довольно длительны по времени, поэтому вам также понадобится инструмент контроля и управления: вы всегда должны видеть, на каком этапе все застряло, какой следующий шаг, сроки, стоимость.Менеджер проекта справочной системы является «двигателем» всего процесса.
В его задачи входит планирование, контроль промежуточных результатов и обеспечение коммуникации между всеми участниками проекта.
1. Краткое описание
Даже если вы собираетесь написать справку самостоятельно, было бы неплохо сначала ответить на ваши вопросы.ряд важных вопросов о продукте .
А если вы заказываете сертификат на стороне, то будет странно, если вам не зададут эти вопросы.
Этот документ (бриф) будет служить своего рода техническим заданием для технического писателя.
В процессе наполнения вы точно определяете требования к формату справки, примерному объему текста, целевой аудитории, языкам, уровню подготовленности пользователя и т. д.
2. Содержание
Наличие правильного контента – это половина дела.Если справочный материал хорошо структурирован, ваши пользователи найдут нужную информацию за пару кликов.
Не спешите писать текст сразу; лучше детально проработать иерархию и уровни вложенности тем.
Для работы со структурой справки можно использовать простой электронная таблица .
По мере компиляции контента вы сможете определиться с моментами, которые необходимо упомянуть, ключевыми словами (онлайн-помощь на сайте также послужит для SEO), количеством и содержанием скриншотов, а также примерным объемом текста.
На этом этапе вы можете оценить сроки и бюджет проекта.
Контент пишется техническим писателем и утверждается разработчиком.
После утверждения контента технический писатель приступает к написанию текста тем.
3. Помогите с дизайном
Общий дизайн справки может как отпугнуть пользователя, так и, наоборот, показать, что разработчику важна каждая мелочь.Если ваш бюджет позволяет, но душа требует красоты, то наймите для этой задачи дизайнера.
Вам необходимо определиться с шаблонами и стилями страниц для всех форматов справки, выбрать разрешение и тему скриншотов.
Небольшая подсказка: черный текст (а для любителей яблок — серый и синий) на белом фоне всегда выглядит аккуратно и профессионально, поэтому не спешите напихивать в дизайн кучу цветов, стилей и прочих украшений.
Выполняйте все дизайнерские работы параллельно и независимо от написания текста.
Таким образом вы сэкономите время и быстрее получите пилотную версию сертификата.
4. Контроль промежуточных версий
Разделите справку на несколько частей и попросите технического писателя прислать промежуточную версию справки после завершения каждой части.Все корректировки текста, содержания и оформления вносите на самых ранних стадиях проекта — так писатель сможет учесть ваши замечания и замечания при создании последующих текстов.
Если вы пишете текст самостоятельно, попросите третьих лиц оценить промежуточные результаты работы.
Как показывает практика, это может быть очень полезно.
5. Финальная версия
Когда все темы уже написаны, сделайте небольшой перерыв, чтобы передохнуть и посмотреть на результат свежим взглядом.Что делать, если вы что-то пропустили? А может быть, что-то надо сократить? Прочтите полученную справку полностью и внесите окончательные изменения.
6. Корректура (корректура)
Я рекомендую поручить корректуру текста справки профессиональному редактору.Грамотный текст, отсутствие опечаток и ошибок повышают доверие пользователей к компании и авторитет разработчика.
7. Экспорт документации
После внесения всех правок в редакторе и настройки дизайна сделайте окончательный экспорт справочного проекта во все необходимые форматы.И обязательно сохраняйте свои справочные проекты, иллюстрации и все исходники в файловом хранилище, чтобы во время обновления не рвать на себе волосы из-за утерянных исходников.
Инфраструктура
Для хранения справочных проектов, иллюстраций и исходных данных я рекомендую использовать облачные хранилища данных с многопользовательской функциональностью и контролем версий (dropbox, box.com), а также онлайн-документы (googe docs, office360).Подходит в качестве хранилища данных Box.com .
Плюсы:
- синхронизация с локальными файлами
- Система уведомления
- комментарии к файлам
- история версий
- права доступа
Плюсы:
- многопользовательское онлайн-редактирование, уровни доступа
- автоматическое сохранение, история изменений
- расширение функциональности с помощью скриптов
- нет необходимости покупать пакет офисного программного обеспечения
- система комментариев
Финал
После заполнения справки разместите ее в Интернете, распечатайте руководство или интегрируйте контекстно-зависимую справку в программу.Но это далеко не конец.
Следующий этап — обновление или перевод справки.
Об этих задачах я расскажу в следующих постах.
А пока жду ваших комментариев, предложений и вопросов.
Как написать справочную документацию? об авторе Алконост помолвлен локализация приложений, игр и сайтов на 60 языках.
Нативные переводчики, лингвистическое тестирование, облачная платформа с API, непрерывная локализация, менеджеры проектов 24/7, любые форматы строковых ресурсов.
Мы также делаем рекламные и обучающие видеоролики — для сайтов продающих, имиджевых, рекламных, образовательных, тизеров, объяснителей, трейлеров для Google Play и App Store. Более подробная информация: https://alconost.com Теги: #alconost #help document #help #help #технический писатель #help #brief #manual #разработка веб-сайта
-
Модель «Хищник-Жертва» В Node.js
19 Oct, 24 -
Firefox Будет Портирован На Qt
19 Oct, 24 -
Будущее Сотовых Операторов
19 Oct, 24
