Автоматизированная публикация справки и методических рекомендаций к сбору отчтености в информационных системах на портал Wiki. Портал доступен из внутреннего источника по адресу http://server1c-pc/.

Скачать инструкцию в формате PDF Ведение перечня информации для формирования справок включает в себя:

• Описание функциональных возможностей компонент системы (объектов метаданных) – справочников, документов, обработок
• Описание функциональных возможностей системы
• Описание формируемой отчетности

На первом этапе необходимо внести информацию по функциональному составу конфигурации. Это можно сделать в справочнике конфигурации

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

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

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

Рассмотрим основное функциональное окно.

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

В зоне Слева (1) отображается дерево метаданных (в разбивке как в конфигураторе), перечень функциональных возможностей и отчетности. В верхней части дерева в командной панели находится кнопка «Создать задачу – документация». Она инициирует диалог постановки задачи на разработку документации по текущему выделенному объекту метаданных в дереве.

Центральная зона (2) отображает текущую выложенную справку к активному элементу справочника из зоны (1).

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

В Нижней правой зоне (4) отображается актуальный список тестов к активному элементу метаданных

В верхней зоне (5) устанавливаются отборы. Наиболее интересный отбор – по периоду – покажет список метаданных, который был изменен за указанный период.

В командной панели центральной зоны(6) выведены управляющие команды.

По команде «Редактирование инструкции» - открывается MS Word где нужно заполнить инструкцию. После завершения внесения данных и закрытии документа, производится его загрузка в систему и производится автоматизированная публикация обновленного руководства на портале вики.

Чтобы написать инструкцию – нужно нажать на команду «Редактирование инструкции» - откроется MS Word, где нужно внести изменения в инструкцию и после его закрытия произойдет автоматическое обновление страницы Wiki.

По команде «Чтение инструкции» - открывается актуальный файл инструкции для чтения

По команде «Публикация в Wiki» происходит публикация материалов на сайте.

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

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

Требования к составлению Wiki-инструкции

Инструкция для выгрузки на wiki-портал имеет ряд ограничений в форматировании:

• Не поддерживается выравнивание элементов на форме.

• Форматированные и нумерованные списки сохраняются в упрощенном виде – не допускается использование многоуровневых списков.

• Не поддерживаются концевые сноски.

• Не поддерживается название рисунка, добавленное из контекстного меню рисунка «Вставить название».

• Не поддерживаются фигуры, вставленные непосредственно в Word’е – стрелки, квадраты и прочие элементы, «накладываемые» поверх текста и изображений в документе.

• Не поддерживается обрезка изображений непосредственно в Word’е – изображение должно быть добавлено в документ уже кадрированным и помеченным выделениями и описаниями.
• Гиперссылки при выгрузке преобразуются в обычный текст.

• Жирный, курсив, подчеркнутый.
• Нумерация списка без вложенных уровней.
• Маркирование списка без вложенных уровней.
• Использование стилей текста: Название, Заголовок 1-2, Подзаголовок, Обычный текст.

• Подпись к рисунку должна представлять собой обычный текст. Последующий текст инструкции должен быть отделен пустой строкой для удобства восприятия.

1. Файл инструкции создается из формы УП. Форматирование остается по умолчанию: шрифт Calibri, 11 пт, выравнивание по левому краю.
2. Рекомендуемый формат скриншотов – изображение в формате jpg, либо скриншот из буфера обмена, вставленный напрямую в документ.
3. Допускается центрирование изображений для удобства редактирования. Положение изображения («В тексте») и обтекание текстом (так же «В тексте») должны остаться по умолчанию.
4. При составлении инструкции обязательным условием является использование стандартных стилей текста для форматирования заголовков.

При составлении инструкций для выгрузки на wiki-портал рекомендуется придерживаться подхода «Одна проблема – Один алгоритм». То есть:

• Инструкция не должна описывать функциональные возможности программы – она должна описывать пошаговый алгоритм решения какой-либо задачи или проблемы.
• В рамках отдельного алгоритма решение задачи должно описываться максимально исчерпывающе, чтобы пользователю не приходилось «скакать» между отдельными алгоритмами.
• Допускается выделять крупные блоки алгоритмов, представляющие завершенное решение отдельной общей задачи, в отдельные инструкции для обращения к ним из других алгоритмов-инструкций.
• Старайтесь избегать штампов и канцелярского языка – говорите с пользователем на его языке, а не языке 1С.
• Если у разных пользователей один и тот же функционал может выглядеть по-разному – сообщите об этом в инструкции.
• Если для выполнения действия доступна горячая клавиша или комбинация клавиш – сообщайте об этом.
• Думайте о том, какой вопрос может задать пользователь при попытке найти ответ на решение задачи или проблемы – пусть он и будет названием алгоритма-инструкции.

• На каждую функциональную возможность конфигурации создается отдельный документ инструкции.
• Список функциональных возможностей в общем случае должен повторять список подсистем конфигурации для удобства навигации по справочной системе.
• Инструкция по функциональной возможности представляет собой перечень алгоритмов, позволяющих решить конкретную задачу. Название каждого отдельного алгоритма-инструкции должно отражать решаемую задачу в виде, понятном пользователю, например «Занесение «старых» инвентарей» или «Настройки принтера HP P1102 для печати книжных формуляров». Повторюсь: старайтесь избегать штампов и канцелярского языка – говорите с пользователем на его языке, а не языке 1С.
• Название каждого отдельного алгоритма-инструкции в документе должно быть отформатировано стилем «Заголовок 1» или «Заголовок 2» в зависимости от уровня вложенности – это позволит выделить название отдельного алгоритма-инструкции в общем тексте при выгрузке на сайт, а также сформировать корректный блок «Содержание» на странице функциональной возможности.

Портал WIKI: http:%%//%%wiki.parus-s.ru/doku.php?id=okabu:biblioteka:func:db7d1811_5cf7_11e5_9438_0050569e7e0a

Документ в УП: e1cib/data/Справочник._ИМЦ_ФункциональныеВозможностиСистемы?ref=94380050569e7e0a11e55cf7db7d1811