Программисты уделяют много времени разработке программ, добавлению новых функций, оптимизации кода, но часто забывают о простой справке для пользователей. Много усилий сводится на нет, потому что пользователи не знают возможностей программы. Не хочу затрагивать вечные холивары типа "они не читают", "мы не умеем понятно описать", "а зачем" и т.п. Для тех, кто понимает важность справки и способен из себя выдавить что-то большее, чем "чтобы сохранить, нажмите кнопку Сохранить" предлагаю редактор справочника функций. Кстати, в справке по работе в редакторе справки есть раздел, который описывает принципы создания справки :)
Как правило, основную ценность составляет краткое описание бизнес-процесса или взаимосвязь разных объектов базы. Такая справка бывает полезна не только пользователям, но и программистам в совместном владении конфигурацией и перемственности знаний при смене работы. Стандартная справочная система конфигурации больше отвечает за статическое описание элементов одной формы, а не связи и функции конфигурации в целом. В дополнение к стандартной справке хорошо использовать данный редактор справочника функций.
Редактор позволяет загрузить дерево метаданных описываемой конфигурации, создать тексты описаний, вставить картинки, указать ссылки на другие разделы и результат встроить в рабочую базу данных. В итоге получается что-то похожее на "Быстрое освоение" в УТ 10 и других типовых конфигурациях.
Основные возможности
- разработка текстов описаний во встроенном редакторе HTML
- назначение видимости разделов по ролям пользователей описываемой конфигурации. Пользователи с разными правами могут видеть разное содержание справочника функций
- интеграция с описываемой конфигурацией в виде ссылок на формы и встроенные разделы стандартной справки
- полнотекстовый поиск по содержимому справочника функций
Код открыт, можете дорабатывать под свои потребности.
p.s. Редактор запускать в режиме "Толстый клиент управляемое приложение"
Вступайте в нашу телеграмм-группу Инфостарт
