Разработка пользовательской документации для бухгалтерского ПО и систем учета: особенности, инструменты, специальные приемы

Журавлев Денис

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

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

Быстрое освоение системы

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

Снижение количества ошибок

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

Автоматизация и интеграция систем

Современные системы бухгалтерского учета часто интегрированы с другими корпоративными системами (например, ERP). Эти сложные многомодульные конструкции очень сложны для понимания даже опытным специалистам. Написание единой справочной базы облегчает понимание концепций и наглядно объясняет взаимосвязанность систем. Об особенностях создания пользовательских инструкций для ERP-систем мы писали в этом материале.

Контроль и аудит

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

Единый стандарт ввода данных

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

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

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

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

Сложности при написании пользовательской документации для бухгалтерского ПО и систем учета

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

Специфика бухгалтерских терминов

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

Регулярная смена законодательства

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

Разный уровень пользователей

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

Обилие функций и возможностей

Современные системы учета предлагают широкий спектр возможностей: от простого ввода данных до сложных аналитических отчетов и автоматизации процессов. Описание всех функций и сценариев использования — задача трудоемкая, особенно когда система имеет модульную структуру и различные конфигурации под разные виды бизнеса. От автора требуется умение ориентироваться во внутренней кухне бухгалтерии, чтобы не просто описывать те или иные возможности ПО, но и объяснять, как именно определенный инструмент решит задачу пользователя и для каких случаев предпочтителен тот или иной функционал. Иначе говоря, важно уметь объяснить не только "как", но и "почему".

Интеграция с другими системами

Как уже замечено ранее, многие бухгалтерские программы интегрируются с внешними системами (CRM, ERP, банковские сервисы и т.д.). При этом возникает сложность в описании взаимодействия между различными компонентами, а также возможных проблем совместимости. Автор справочной базы должен быть знаком и с этими нюансами.

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

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

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

Используйте простые объяснения

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

Например, вместо

"Кнопка Создать во вкладке Продажи создает новую счет-фактуру"

напишите

"Чтобы создать новую счет-фактуру, перейдите во вкладку Продажи и нажмите кнопку Создать".

Или вместо

"Кнопка Применить в окне Редактор панелей позволяет создать нужную панель. Редактор панелей можно вызвать на вкладке Журнал операций"

напишите

"Чтобы создать новую панель, перейдите на вкладку Журнал операций, выберите соответствующую панель и нажмите Применить".

Создайте глоссарий

Глоссарий в пользовательской документации является признаком качественной и профессиональной работы, которая ориентирована на удобство пользователя. Он полезен по ряду причин.

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

Рекомендуем использовать перекрестные ссылки между терминами, если они связаны между собой.

Поддерживайте актуальность информации

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

Учитывайте сегментированность аудитории

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

Форматируйте контент

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

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

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

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

EasyData

EasyData создает программное обеспечение для работы с большими данными, а также высоконагруженные комплексные real-time решения. Владимир Баранов, генеральный директор компании EasyData, рассказал о том, почему они больше не пишут пользовательскую документацию в Microsoft Word, а перешли на специализированный профессиональный софт Dr.Explain.

— Для распространения решений собственной разработки нужно было создать пользовательскую документацию по продуктам, а также опубликовать ее в виде online-справки на сайте. Ранее пользовательская документация создавалась и публиковалась в формате Microsoft Word, и иногда экспортировали ее в PDF-формат. Мы искали гибкие и удобные инструменты для управления пользовательской документацией. В итоге остановились на Dr.Explain, так как нам понравился интерфейс и возможность создавать различные форматы документов из одного проекта.

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

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

Трэйдсофт

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

— Наша компания с 2003 года занимается разработкой программного обеспечения для автобизнеса. На сегодняшний день это экосистема программных продуктов: интернет-магазин автозапчастей; программа для учета и продажи запчастей + CRM; комплекс для онлайн- и офлайн торговли; каталоги оригинальных запчастей; каталоги автотоваров; веб-сервисы для упрощения продаж.

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

Было решено найти новую для создания пользовательских документаций для систем учета.

— В сравнение участвовали продукты аналогичные MS Word, продукты упрощенной верстки, в основном используемые разработчиками, а также специализированный софт для ведения документации и заметок. Основными критериями выбора нового продукта для ведения документации были: легкая конвертация из формата DOC/DOCX в новый, сохранение и расширение возможностей визуального оформления документа, возможность получить на выходе легкий способ онлайн-доступа к документации. Также немаловажным являлась стоимость продукта/рабочего места, возможность расширения лицензии, развитие продукта и обновления, доступ к технической поддержке. Выбранный инструмент должен был ускорить процесс подготовки и публикации документации. Dr.Explain подошел почти по всем критериям.

Николай Вальковец, разработчик компании 2V, рассказывает о том, что документация, написанная в программе Dr.Explain, помогла избежать создания call-центра с техподдержкой, а также избавила от проведения онлайн презентаций и видеоконференций для новых клиентов.

— Наша команда разрабатывает несколько программных продуктов для оперативного учёта в разных сферах бизнеса. Основной сферой является сфера кредитования, то есть ПО для микрофинансовых организаций «2V: Кредит» и кредитно потребительских кооперативов «2V: Вклад», также у нас есть решения по учету в стоматологии и клинике «2V: Стоматология». В какой-то момент стало ясно, что без ясной, наглядной документации будет тяжело наращивать дальнейшие обороты и подключения клиентов. Изначально мы планировали содержать собственный call-центр с техподдержкой. Но позже пришло понимание, что хоть программа и имеет сложные для понимания моменты на первых шагах для неопытного пользователя, на самом деле все их можно описать и представить для новых клиентов в удобном формате в момент их подключения или ознакомления с ПО. А на техническую поддержку оставить только нетиповые вопросы.

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

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

— Нам импонирует простота программы и скорость работы. Можно быстро редактировать, добавить новые пункты в документацию, сохранить в формате HTML и выложить на сайт. Также не маловажным фактором для нас стала удобная работа с изображениями с возможностью аннотирования картинки. Наша практика подтверждает мнение ученых, действительно, 80% информации усваивается человеком визуально. Как подробно не описывать пользователю в виде текста ту или иную особенность программы, гораздо быстрее приходит понимание работы, когда человек видит визуальный пример. Хочется поблагодарить команду Dr.Explain за такой качественный, простой и удобный продукт.

Самое время узнать, какие возможности предоставляет программа Dr.Explain.

Dr.Explain — инструмент, ускоряющий создание пользовательской документации для бухгалтерского ПО и систем учета

Dr.Explain — это зарекомендовавший себя продукт российских разработчиков с богатой историей. Вот некоторые из его особенностей.

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

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

Для упрощения навигации в контенте, насыщенном медиа материалами, создатели Dr.Explain придумали стилизацию нумерованных изображений и таблиц. К примеру, нумерация таблиц с именами сотрудников компании оформляется в одном стиле, а нумерация подрядчиков, заказчиков в другом. А нумерацию изображений графиков можно стилизовать так, чтобы она отличалась от оформления изображений интерфейса.

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

Организация работы групп авторов

Многие пользовательские справки пишутся одновременно целой группой авторов. В таких случаях не обойтись без функционала совместной работы над одним документом. В Dr.Explain это реализовано при помощи облачного сервиса TiWri.

Экспорт документов в HTML, PDF, Word, CHM

С Dr.Explain не приходится создавать отдельную документацию для каждого формата. Вы легко экспортируете проект, например, в HTML для публикации в интернет. Есть возможность настройки вывода определенных разделов: например, экспортировать определенный контент для одной группы пользователей и исключить из экспорта для другой.

Шаблоны руководства пользователя с готовой структурой

Приступить к написанию справочной базы в Dr.Explain очень просто, вам помогут заготовки с заранее подготовленной структурой разделов.

Заключение

База знаний — это почти как персональный ментор, который говорит с тобой на одном языке и доступен 24 часа в сутки. Людям, которые постоянно заняты отчетами, балансами и налоговыми инспекциями, сложно работать без простого и понятного сборника инструкций по работе с финансовым ПО.