Как мы отражаем документацию по системе 1С OneNote

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

Наша система часто изменяется и дорабатывается, а также меняются правила работы с ней без изменения кода. Пользователей достаточно много. Одни забывают, другие уходят и приходят, меняются разработчики и ключевые сотрудники. В итоге часто пользователи задают вопросы «как это сделать?» или еще интереснее «А почему так было сделано?». Естественно для ответа на этот вопрос можно полезть в код(если там есть ссылка на задачу или описание) но это оптимально и отнимает время у консультанта/программиста 1С.

Встроенная справка не подходит по следующим причинам:

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

Wiki

Был очередной шаг сделать описание системы. Подняли свой сайт на типовом движке. Начали наполнять информацией. Wiki позволяет создать действительно удобную справку со ссылками на другие элементы, удобным поиском, отображает список изменений через RSS, что крайне удобно и позволяет быть в курсе всех изменений другим разработчикам и консультантам. Но система имеет один большой для нас недостаток — это трудозатратность поддержки. Тратится достаточно много усилий на поддержание справки и на ее внесение. Например описание с картинками и разными стилями и таблицами внести в Word поставляет 5 минут, а в Wiki — 20 минут(а может и больше). Необходимо отдельно загружать графические файлы и прописывать на них ссылку.

Microsoft OneNote

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

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

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

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

Преимущества, которые мы получили при использовании последнего ПО:

• Редактируется легко, почти как MS Word.
• Не привязано к конфигурации 1С.
• Гибкий поиск по словам.
• Древовидная структура записей с группами разделов. Редактированные недавно разделы выделяются в структуре жирным.
• Хранится история изменений, можно посмотреть список изменений за интервал времени, а также авторов этих изменений.
• Можно задать пароль на определенные разделы.
• Можно разрешить ключевым сотрудника редактировать описание(не только программистам).
• Можно редактировать через WEB интерфейс, что является плюсом.

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

Техническая теализация связи со справкой:

Mirosoft OneNote развернут на портале SharePoint, где опубликована ссылка на наш файл OneNote.

В системе создается специальный справочник — Справка по объектам. Например: наименование = «Справочник.Сертификаты» и ссылка на справку.

Создается общая команда «СправкаПоОбъекту», она вызывается из любой формы списка или элемента. При переходе на по этой ссылке в 1С открывается само содержание справки.