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

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

Мы разработаем справку "с нуля", либо доработаем уже имеющуюся программную документацию для приложений под 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.

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

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


  • Blogun
    Aviasales
    Bitrix24
    Endomondo

    RSDN
    Habrahabr
    App2Top
    GCUP
  • Webmoney
    Itransition
    Biolink
    Smarty CRM

    Цукерберг позвонит
    RSDN
    mdday
    The Village
  • Prestigio
    Mipko
    Viber
    Endomondo

    ain.ua
    App2Top
    mdday
    The Village
  • Agnitum
    Kaspersky
    Nevosoft
    Viber

    Pocket Gamer
    RSDN
    App2Top
    Software-Testing.RU
  • Aviasales
    RJ Games
    Stoik
    Smarty CRM

    Цукерберг позвонит
    App2Top
    mdday
    Software-Testing.RU
  • Alawar
    PROMT
    Prestigio
    Blogun

    DTF
    ain.ua
    App2Top
    Software-Testing.RU
  • Kaspersky
    Itransition
    RJ Games
    CleverFiles

    DTF
    ain.ua
    App2Top
    GCUP
  • Webmoney
    Prestigio
    Viber
    Smarty CRM

    ain.ua
    App2Top
    mdday
    The Village
  • Blogun
    Petcube
    Crystal Clear Soft
    Oracle

    Цукерберг позвонит
    Pocket Gamer
    RSDN
    mdday
  • Alawar
    EPAM
    Mildmania
    RJ Games

    Habrahabr
    ain.ua
    App2Top
    mdday
  • Prestigio
    Blogun
    RJ Games
    MAPS.ME

    Pocket Gamer
    RSDN
    Software-Testing.RU
    GCUP
  • EPAM
    Petcube
    Stoik
    MAPS.ME

    Pocket Gamer
    ain.ua
    Software-Testing.RU
    GCUP
  • Agnitum
    Itransition
    Blogun
    Atola

    Цукерберг позвонит
    Pocket Gamer
    DTF
    The Village
  • Webmoney
    Biolink
    Petcube
    Smarty CRM

    Pocket Gamer
    Habrahabr
    App2Top
    mdday
  • Kaspersky
    Blogun
    101 XP
    CleverFiles

    Habrahabr
    ain.ua
    App2Top
    The Village
  • PROMT
    EPAM
    RJ Games
    MAPS.ME

    RSDN
    DTF
    ain.ua
    The Village
  • Softline
    Xsolla
    Aviasales
    Mipko

    RSDN
    Habrahabr
    ain.ua
    The Village
  • PROMT
    Softline
    Petcube
    Mipko

    Цукерберг позвонит
    Pocket Gamer
    App2Top
    GCUP
  • Itransition
    Blogun
    Biolink
    CleverFiles

    Pocket Gamer
    RSDN
    Software-Testing.RU
    The Village
  • Webmoney
    Nevosoft
    Yandex
    Option Workshop

    Цукерберг позвонит
    ain.ua
    App2Top
    The Village
  • Blogun
    Biolink
    Viber
    Oxagile

    Pocket Gamer
    App2Top
    Software-Testing.RU
    GCUP
  • Prestigio
    RJ Games
    Oxagile
    Stoik

    Цукерберг позвонит
    Pocket Gamer
    DTF
    mdday
  • PROMT
    Itransition
    Petcube
    Yandex

    Цукерберг позвонит
    Pocket Gamer
    RSDN
    GCUP
  • Kaspersky
    Atola
    RJ Games
    Smarty CRM

    Цукерберг позвонит
    RSDN
    DTF
    ain.ua
  • PROMT
    EPAM
    Mildmania
    Smarty CRM

    Цукерберг позвонит
    DTF
    mdday
    The Village
  • EPAM
    Jooble
    Smarty CRM
    Endomondo

    DTF
    ain.ua
    mdday
    GCUP
  • Softline
    Mipko
    RJ Games
    Option Workshop

    DTF
    App2Top
    mdday
    Software-Testing.RU
  • Prestigio
    Biolink
    Petcube
    Endomondo

    Цукерберг позвонит
    Pocket Gamer
    ain.ua
    App2Top
  • Biolink
    Petcube
    101 XP
    Oxagile

    Pocket Gamer
    Habrahabr
    Software-Testing.RU
    GCUP
  • Agnitum
    Webmoney
    Bitrix24
    Option Workshop

    RSDN
    DTF
    App2Top
    mdday
  • Agnitum
    Xsolla
    CleverFiles
    MAPS.ME

    Habrahabr
    ain.ua
    mdday
    Software-Testing.RU
  • Softline
    Mildmania
    Crystal Clear Soft
    Smarty CRM

    Цукерберг позвонит
    ain.ua
    mdday
    GCUP
  • EPAM
    Nevosoft
    Oxagile
    Smarty CRM

    RSDN
    DTF
    Software-Testing.RU
    The Village
  • Jooble
    Petcube
    Mipko
    Bitrix24

    RSDN
    Habrahabr
    mdday
    Software-Testing.RU
  • Agnitum
    Option Workshop
    Oracle
    MAPS.ME

    Цукерберг позвонит
    Pocket Gamer
    App2Top
    mdday
  • Blogun
    Mildmania
    Jooble
    Oracle

    DTF
    Habrahabr
    mdday
    Software-Testing.RU
  • Webmoney
    EPAM
    Itransition
    Nevosoft

    Цукерберг позвонит
    Habrahabr
    App2Top
    The Village
  • Softline
    Atola
    Viber
    Bitrix24

    Цукерберг позвонит
    App2Top
    GCUP
    The Village
  • Mipko
    Option Workshop
    Smarty CRM
    Oracle

    Pocket Gamer
    RSDN
    Habrahabr
    ain.ua
  • Agnitum
    EPAM
    Nevosoft
    Aviasales

    Цукерберг позвонит
    Pocket Gamer
    Software-Testing.RU
    The Village
  • Nevosoft
    Biolink
    Crystal Clear Soft
    Smarty CRM

    Habrahabr
    ain.ua
    mdday
    The Village
  • PROMT
    Nevosoft
    Jooble
    101 XP

    Цукерберг позвонит
    ain.ua
    GCUP
    The Village
  • Alawar
    PROMT
    Aviasales
    Bitrix24

    Pocket Gamer
    ain.ua
    GCUP
    The Village