gifts2017

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

Опубликовал Владимир Чепурной (91197ch) в раздел Управление - Пользователю системы

Опишу наш опыт написания инструкций пользователям по работе в 1С. И какими средствами мы это делали. И на чем собственно мы остановились.

Перед стартом 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С открывается само содержание справки.

 

 

См. также

Подписаться Добавить вознаграждение
Комментарии
1. Роман Романов (romansun) 11.01.13 21:38
хм.... занятно, спасибо

а в шарепоите что ведете?
2. Евгений Сосна (pumbaE) 13.01.13 10:41
Как быстро документация устаревает, кто следит за актуальностью?
3. Яков Коган (Yashazz) 14.01.13 10:25
Автор, что такое "толмут" в вашем тексте?

Эхма, выложить, что ли, свой вариант решения проблемы...
4. Владимир Чепурной (91197ch) 14.01.13 11:59
(2) pumbaE, как только сотрудник выполняет задачу он получает еще одну задачу - отразить это в документации.
5. Владимир Чепурной (91197ch) 14.01.13 12:01
(3) Yashazz, Толмут - конечно исправлю в тексте на большое количество листов
6. Владимир Чепурной (91197ch) 14.01.13 12:03
(1) romansun, на шарапоинте корпоративный портал поднят.
7. Евгений Сосна (pumbaE) 15.01.13 17:35
(4) 91197ch, а как программист узнает, что изменение в общем модуле ОбработкаТабличныхЧастей, должно изменить инструкцию например "Как отчитаться поставщику?"
8. Сергей Кулешов (KulSer) 16.01.13 09:46
(3) Проблема, поднятая автором, для нас действительно актуальна. Так что, если у Вас есть свой вариант, - выкладывайте.
9. Игорь Steelvan (Steelvan) 16.01.13 12:16
Интересная программа, уже нашел видео по ней.
Сам использую MyNotesKeeper - позволяет также работать в древовидном режиме. Плюс генерирует exe книжки.

Только нет истории изменений, это напрягает при написании версий ТЗ.
Попробую эту разобрать.
И по цене вроде не дорого.
10. Владимир Чепурной (91197ch) 16.01.13 15:27
(7) pumbaE, я являюсь и архитектором и главным аналитиком, поэтому после выполнения задачи я прошу программистов поправить инструкции.
11. Евгений Сосна (pumbaE) 16.01.13 15:52
(10) 91197ch, понятно. У меня, дабы не забыть каждая инструкция привязана к определенной или нескольким подсистемам, когда изменяется объект конфигурации, то для всех вики подсистем (вики страничка с названием подсистемы), в которые входит этот объект добавляется ссылка на задачу. И открыв подсистему, я могу оперативненько сказать, какую инструкцию необходимо изменять из-за решенной этой задачи. Пока это работает в полуручном режиме, но когда добью соответствующий плагин для снегопата и redmine , думаю получиться чуть автоматизировать этот труд и уменьшить список "забытых" инструкций.
12. Сергей Кудашкин (sikuda) 18.01.13 09:16
Не совсем понял по требования по ПО:
- Microsoft Office (OneNote) для каждого сотрудника
- SharePoint на одном сервере
Так?
13. Игорь Steelvan (Steelvan) 19.01.13 15:21
В общем посмотрел я видео по этой программе.
По сравнению с MyNotesKeeper не нашел преимуществ.
Также можно работать в древовидном режиме, выгружать всю книгу, или ее часть в различные форматы.
От создания книги в формате exe и справки windows, до выгрузки каждой страницы в HTML для создания внутреннего сайта со справкой.

Поддерживается выгрузка в RTF.

Вот нет сравнения, но для сравнения можно выгрузить два документа в RTF и сравнить тем же OpenOffice.

Как плюс, можно изменять иконки в узлах дерева.
Например, для того, что бы использовать при тестировании, типа прошел тест, описанный на этой странице или нет.
14. Евгений Сосна (pumbaE) 19.01.13 19:01
(13) Steelvan, посмотри в сторону svn и tortoise , там с ним идут скрипты по вызову сравнения rtf/doc/odt файлов как в openoffice , так и с помощью word . Вот и будет вам история.
15. Владимир Чепурной (91197ch) 24.01.13 17:14
(12) sikuda, Да, программу ставим только тем кто редактирует эти статьи. Остальные через Веб доступ с ней работают. Хотя Веб доступ также позволяет редактировать. Но он менее удобен для этого.
16. Роман Романов (romansun) 01.02.13 18:27
Коллеги, а поделитесь, кто в чем еще ведет справочную систему?
17. Яков Коган (Yashazz) 07.10.13 17:09