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

14.01.13

Управление ИТ - Стандарты и документация

Опишу наш опыт написания инструкций пользователям по работе в 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С открывается само содержание справки.

 

 

Вы можете заказать платную адаптацию этой статьи под ваши задачи на «Бирже заказов».

  • 0% комиссии — оплата напрямую исполнителю;
  • Исполнители любого масштаба — от отдельных специалистов до команд под проект;
  • Прямой обмен контактами между заказчиком и исполнителем;
  • Безопасная сделка — при необходимости;
  • Рейтинги, кейсы и прозрачная система откликов.

См. также

Стандарты и документация Бесплатно (free)

Разбираем ISO/IEC 42001:2023 – самостоятельный стандарт по системам менеджмента искусственного интеллекта, построенный на логике ISO/IEC 27001 и расширяющий привычные подходы информационной безопасности на разработку, поставку и использование ИИ-систем. Показываем, как типовая модель оценки рисков дополняется анализом воздействия на бизнес и общество, а приложение А объединяет меры управления рисками в десять групп контролей. Объясняем, чем отличаются требования к разработчикам, поставщикам и пользователям систем искусственного интеллекта и какие риски каждая из сторон должна учитывать на своих этапах жизненного цикла. Материал будет полезен специалистам по информационной безопасности и разработчикам информационных систем, интегрированных с ИИ.

31.07.2026    254    0    roman_nikishov    0    

1

Стандарты и документация Бесплатно (free)

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

29.07.2026    340    0    OksanaBogdashkina    2    

2

Стандарты и документация Бесплатно (free)

В прошлых статьях я читал профстандарты и вывел, что архитектор - это тот, кто принимает архитектурные решения. А теперь неожиданный поворот: если открыть профстандарт «Системный аналитик», выяснится, что аналитик высокого уровня как раз такие решения и принимает. То есть, сюрприз, аналитик и есть архитектор. Просто функциональный. И это не мой комплимент аналитикам, а вывод прямо из формулировок Минтруда.

27.07.2026    374    8    ardn    2    

6

Стандарты и документация Россия Бесплатно (free)

«Зачем писать бумажки, если можно писать код?» — этот вопрос я слышу на каждом втором проекте. В статье разбираю на живом примере — подсистеме динамических констант, прошедшей путь от идеи до поставки с формами, ролями и юнит-тестами, — что реально дает технический проект, когда он окупается за первую же неделю, а когда превращается в карго-культ. Отдельно — почему в эпоху ИИ-ассистентов технический проект внезапно стал нужнее, а не наоборот.

21.07.2026    276    0    chagbig    0    

2

Стандарты и документация Россия Бесплатно (free)

Продолжаю разбирать профстандарты. Беру стандарт «Архитектор программного обеспечения» (06.003) и сверяю с тем, кого у нас в 1С зовут архитектором. Зовут кого угодно - спеца по производительности, тимлида, ревьювера, самого опытного на проекте, - но почти никогда того, кто на самом деле делает работу архитектора. А она одна: принимать архитектурные решения и отвечать за них.

06.07.2026    1346    25    ardn    16    

14

Компетенции и навыки Стандарты и документация Программист Россия Бесплатно (free)

Разбираю профстандарт «Программист» - что государство официально считает нашей профессией, какие трудовые функции в нее входят и почему «я в домике, не трогайте, я программирую» - позиция, противоречащая стандарту. Название провокационное, но я не шучу: к концу статьи объясню, почему «разработчик» - просто красивое слово для программиста.

22.06.2026    4679    18    ardn    46    

25

Стандарты и документация Бесплатно (free)

Про то, как перестать терять знания о принятых архитектурных решениях. Разбираю, что такое Architecture Decision Record (ADR) и как начать вести его буквально сегодня.

18.06.2026    1815    0    ardn    10    

19

Стандарты и документация Бесплатно (free)

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

18.06.2026    610    0    YA_826532418    3    

4
Комментарии
Подписаться на ответы Инфостарт бот Сортировка: Древо развёрнутое
Свернуть все
1. romansun 213 11.01.13 21:38 Сейчас в теме
хм.... занятно, спасибо

а в шарепоите что ведете?
6. 91197ch 30 14.01.13 12:03 Сейчас в теме
(1) romansun, на шарапоинте корпоративный портал поднят.
2. pumbaE 13.01.13 10:41 Сейчас в теме
Как быстро документация устаревает, кто следит за актуальностью?
4. 91197ch 30 14.01.13 11:59 Сейчас в теме
(2) pumbaE, как только сотрудник выполняет задачу он получает еще одну задачу - отразить это в документации.
7. pumbaE 15.01.13 17:35 Сейчас в теме
(4) а как программист узнает, что изменение в общем модуле ОбработкаТабличныхЧастей, должно изменить инструкцию например "Как отчитаться поставщику?"
10. 91197ch 30 16.01.13 15:27 Сейчас в теме
(7) pumbaE, я являюсь и архитектором и главным аналитиком, поэтому после выполнения задачи я прошу программистов поправить инструкции.
11. pumbaE 16.01.13 15:52 Сейчас в теме
(10) понятно. У меня, дабы не забыть каждая инструкция привязана к определенной или нескольким подсистемам, когда изменяется объект конфигурации, то для всех вики подсистем (вики страничка с названием подсистемы), в которые входит этот объект добавляется ссылка на задачу. И открыв подсистему, я могу оперативненько сказать, какую инструкцию необходимо изменять из-за решенной этой задачи. Пока это работает в полуручном режиме, но когда добью соответствующий плагин для снегопата и redmine , думаю получиться чуть автоматизировать этот труд и уменьшить список "забытых" инструкций.
3. Yashazz 4932 14.01.13 10:25 Сейчас в теме
Автор, что такое "толмут" в вашем тексте?

Эхма, выложить, что ли, свой вариант решения проблемы...
5. 91197ch 30 14.01.13 12:01 Сейчас в теме
(3) Yashazz, Толмут - конечно исправлю в тексте на большое количество листов
8. KulSer 16.01.13 09:46 Сейчас в теме
(3) Проблема, поднятая автором, для нас действительно актуальна. Так что, если у Вас есть свой вариант, - выкладывайте.
9. Steelvan 317 16.01.13 12:16 Сейчас в теме
Интересная программа, уже нашел видео по ней.
Сам использую MyNotesKeeper - позволяет также работать в древовидном режиме. Плюс генерирует exe книжки.

Только нет истории изменений, это напрягает при написании версий ТЗ.
Попробую эту разобрать.
И по цене вроде не дорого.
12. sikuda 686 18.01.13 09:16 Сейчас в теме
Не совсем понял по требования по ПО:
- Microsoft Office (OneNote) для каждого сотрудника
- SharePoint на одном сервере
Так?
15. 91197ch 30 24.01.13 17:14 Сейчас в теме
(12) sikuda, Да, программу ставим только тем кто редактирует эти статьи. Остальные через Веб доступ с ней работают. Хотя Веб доступ также позволяет редактировать. Но он менее удобен для этого.
13. Steelvan 317 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 . Вот и будет вам история.
16. romansun 213 01.02.13 18:27 Сейчас в теме
Коллеги, а поделитесь, кто в чем еще ведет справочную систему?
17. Yashazz 4932 07.10.13 17:09 Сейчас в теме
Для отправки сообщения требуется регистрация/авторизация