Разработка справочной документации к ПО

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

Мы разработаем справку "с нуля", либо доработаем уже имеющуюся программную документацию для приложений под Mac OS, Windows, Linux, Android, iOS.

Если необходимо, мы переработаем структуру устаревшего хелпа, допишем тексты, переснимем скриншоты, обновим стили и форматирование.

Тексты справочных материалов всегда вычитываются редакторами-носителями языка.

Наши продукты:

  • Руководства и инструкции пользователя (оператора, программиста, администратора)
  • Справочные системы к программным продуктам
  • «Быстрый старт» (Quick start), «С чего начать» (Getting started)
  • Статьи "How to..."
  • Обзоры программ, статьи о софте
  • Онлайн справка (Online help, Web help)
  • Вики (wiki)
  • Руководства для обозревателя (Reviewer's guide)
  • «Белые книги» (White Papers)
  • ЧАВО (FAQ)
  • Лицензионные соглашения (EULA), Условия использования (Terms of Service), Политика конфиденциальности (Privacy Policy)

Посмотреть примеры работ

Форматы справочных систем

У нас можно заказать написание пользовательской документациив следующих форматах: HTML, CHM, PDF, DOC, RTF, ePUB, EXE (e-Book), HLP, HXS (MSHC).

Инструменты для разработки справки

Для создания справочной документации мы используем и рекомендуем:

Обновление и поддержка

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

SEO-оптимизация текстов для онлайн-хелпа

При создании справочных материалов для публикации в интернете (онлайн-справка, статьи "How to...", wiki) имеет смысл намеренно использовать в них ключевые слова. Мы можем подобрать популярные поисковые запросы на любом языке и включить их в help-файл.

Иллюстрации и мультимедиа для справочной документации

Чтобы сделать вашу справку более информативной, мы добавим в неё иллюстрации и мультимедиа: скриншоты, графики, схемы, спецификации, диаграммы, логотипы, видеофайлы и flash.

При необходимости мы сделаем для вас обучающие видеоролики (tutorial, how to) на английском, русском и других языках.

Можно ли успешно аутсорсить разработку хелпов?

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

Вполне. И как раз то, что технический писатель на старте работ не имеет представления о продукте, является преимуществом — он видит программу со стороны пользователя и понимает, какая информация необходима.

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

Наши статьи про разработку справочной документации

Примеры выполненных работ


  • Mildmania
    Biolink
    Option Workshop
    Smarty CRM

    Pocket Gamer
    DTF
    App2Top
    GCUP
  • Atola
    Oxagile
    Crystal Clear Soft
    CleverFiles

    Pocket Gamer
    App2Top
    Software-Testing.RU
    GCUP
  • Agnitum
    Mildmania
    Aviasales
    Endomondo

    Цукерберг позвонит
    DTF
    Habrahabr
    Software-Testing.RU
  • EPAM
    Biolink
    CleverFiles
    MAPS.ME

    Цукерберг позвонит
    RSDN
    ain.ua
    mdday
  • Alawar
    Webmoney
    Blogun
    Biolink

    Pocket Gamer
    DTF
    Software-Testing.RU
    GCUP
  • Agnitum
    Biolink
    Oxagile
    CleverFiles

    DTF
    ain.ua
    Software-Testing.RU
    GCUP
  • Webmoney
    Softline
    Blogun
    101 XP

    Цукерберг позвонит
    ain.ua
    App2Top
    Software-Testing.RU
  • Atola
    Mipko
    101 XP
    Option Workshop

    Pocket Gamer
    mdday
    GCUP
    The Village
  • Alawar
    Xsolla
    Jooble
    Crystal Clear Soft

    Цукерберг позвонит
    DTF
    GCUP
    The Village
  • EPAM
    Atola
    101 XP
    Oxagile

    DTF
    Habrahabr
    Software-Testing.RU
    GCUP
  • Softline
    Mildmania
    Bitrix24
    MAPS.ME

    ain.ua
    App2Top
    mdday
    Software-Testing.RU
  • PROMT
    Xsolla
    Atola
    RJ Games

    Habrahabr
    mdday
    GCUP
    The Village
  • PROMT
    Blogun
    Stoik
    CleverFiles

    mdday
    Software-Testing.RU
    GCUP
    The Village
  • Prestigio
    Atola
    Viber
    Smarty CRM

    RSDN
    Habrahabr
    Software-Testing.RU
    GCUP
  • Blogun
    Mildmania
    Biolink
    MAPS.ME

    Habrahabr
    ain.ua
    mdday
    The Village
  • Alawar
    EPAM
    Petcube
    Aviasales

    Pocket Gamer
    Habrahabr
    mdday
    Software-Testing.RU
  • Itransition
    Blogun
    Jooble
    Bitrix24

    ain.ua
    App2Top
    Software-Testing.RU
    The Village
  • Mildmania
    Petcube
    Crystal Clear Soft
    Smarty CRM

    Цукерберг позвонит
    RSDN
    mdday
    Software-Testing.RU
  • Kaspersky
    RJ Games
    Crystal Clear Soft
    CleverFiles

    RSDN
    ain.ua
    mdday
    The Village
  • Aviasales
    Atola
    Yandex
    101 XP

    Habrahabr
    ain.ua
    Software-Testing.RU
    GCUP
  • Agnitum
    Prestigio
    Petcube
    Atola

    Цукерберг позвонит
    RSDN
    ain.ua
    GCUP
  • Atola
    Oxagile
    Stoik
    Smarty CRM

    Pocket Gamer
    ain.ua
    mdday
    The Village
  • Alawar
    EPAM
    Mipko
    Viber

    Цукерберг позвонит
    DTF
    App2Top
    GCUP
  • Agnitum
    Nevosoft
    Petcube
    Mipko

    Цукерберг позвонит
    ain.ua
    App2Top
    The Village
  • Jooble
    Yandex
    Crystal Clear Soft
    MAPS.ME

    Цукерберг позвонит
    DTF
    mdday
    GCUP
  • Atola
    Bitrix24
    Oxagile
    Oracle

    Цукерберг позвонит
    Habrahabr
    mdday
    The Village
  • Aviasales
    Bitrix24
    Stoik
    Crystal Clear Soft

    DTF
    Habrahabr
    Software-Testing.RU
    GCUP
  • Kaspersky
    Xsolla
    Option Workshop
    Crystal Clear Soft

    mdday
    Software-Testing.RU
    GCUP
    The Village
  • Itransition
    Blogun
    Nevosoft
    CleverFiles

    Pocket Gamer
    ain.ua
    mdday
    GCUP
  • Option Workshop
    Smarty CRM
    CleverFiles
    Oracle

    Цукерберг позвонит
    Pocket Gamer
    App2Top
    The Village
  • PROMT
    Mildmania
    Smarty CRM
    MAPS.ME

    Pocket Gamer
    RSDN
    Software-Testing.RU
    The Village
  • Itransition
    Aviasales
    Mipko
    CleverFiles

    Цукерберг позвонит
    ain.ua
    GCUP
    The Village
  • Prestigio
    Softline
    Biolink
    Aviasales

    RSDN
    ain.ua
    GCUP
    The Village
  • Softline
    Itransition
    Atola
    RJ Games

    Pocket Gamer
    RSDN
    ain.ua
    The Village
  • Prestigio
    Softline
    Xsolla
    Option Workshop

    Pocket Gamer
    RSDN
    Software-Testing.RU
    GCUP
  • Webmoney
    Prestigio
    Xsolla
    101 XP

    Pocket Gamer
    RSDN
    Habrahabr
    The Village
  • Kaspersky
    Itransition
    Viber
    Stoik

    Habrahabr
    ain.ua
    App2Top
    Software-Testing.RU
  • PROMT
    Jooble
    Atola
    Endomondo

    RSDN
    DTF
    ain.ua
    The Village
  • Prestigio
    EPAM
    Option Workshop
    Stoik

    RSDN
    Habrahabr
    App2Top
    GCUP
  • Kaspersky
    Mildmania
    Bitrix24
    Smarty CRM

    Цукерберг позвонит
    ain.ua
    Software-Testing.RU
    GCUP
  • Atola
    Viber
    Option Workshop
    Smarty CRM

    Цукерберг позвонит
    Pocket Gamer
    App2Top
    mdday
  • Biolink
    Viber
    Option Workshop
    MAPS.ME

    Pocket Gamer
    DTF
    Software-Testing.RU
    GCUP
  • Kaspersky
    Softline
    Atola
    Stoik

    Habrahabr
    ain.ua
    mdday
    The Village