Как писать инструкции для пользователей 1с
Обновлено: 07.07.2024
В продолжении своего поста решил написать, как лучше всего создавать инструкции для пользователей и администраторов.
Всем, кому интересно, прошу под хабракат.
Принцип Keep It Simple Stupid хорошо известен в программировании, но почему-то его редко используют для написания инструкций и руководящих документов, предпочитая растекаться мыслею по древу. В 70% ситуаций эта документация необходима только для того, что бы отмахаться от наших бодрых регуляторов, но при этом забывают, что с этой документацией придётся работать, причём не всегда технически подкованным и грамотным в области информационной безопасности людям.
Для начала напишу несколько правил, которые помогут создать рабочий и удобный документ:
1. Старайтесь разделять инструкцию для пользователей от инструкции для администраторов и офицеров безопасности. причём первые не должны содержать ссылок на вторые (они могут содержать отсылки друг к другу).
2. Делайте пошаговые инструкции, вида «взял и сделал». То есть инструкции должны описывать алгоритм действий того, на кого она направлена.
3. Каждый пункт описывайте, как отдельное действие с обязательным указанием ответственного и контактами, если они необходимы.
4. Для большей наглядности можете дополнительно нарисовать в инструкцию блок-схему действий. Это поможет пользователю наглядно понять и оценить действия, так же и вам доступно объяснить алгоритм при обучении.
5. Психологический момент — инструкция будет плохо выполняться и работать, если пользователям понятно и доступно не объяснят алгоритм на пальцах и примерах. Поэтому — НЕ ЗАБЫВАЙТЕ ПРО ОБУЧЕНИЕ!
Пример инструкции для пользователей
Ниже приведен пример инструкции по заведению аккаунта пользователя в корпоративной сети.
Clear screen/clear desk
Специфика российских организаций, работающих с советских времен и таких же умудренных опытом сотрудников такова, что у них, как правило, стол завален бумагами. Компьютер порой не выключается и не блокируется, даже когда уходят домой. Недавно лично видел, проходя поздно вечером мимо одного муниципального предприятия, как за открытыми жалюзи в закрытом на замок здании горел монитор с открытым на нём вордовским документом.
Пользователи порой не догадываются о возможных непреднамеренных утечках информации. Пускай она не конфиденциальна, возможно она только для внутреннего пользования. Но это даёт понимание, что в этой организации не заботятся о своей безопасности и могут так поступить с конфиденциалкой. А так же возможно там будет информация, ещё не отнесенная к закрытой, но уже существующая во внутреннем обороте организации.
Хорошим примером из лучших практик здесь является политики чистого стола и чистого экрана. Их можно описать так же, как я приводил пример ранее, но это будет выглядеть немного глупо, так как действия там простейшие. Лучше просто сделать набором правил:
На этом завершаю примеры и рекомендации. Серию подобных постов я продолжу, если будет интерес.
Часто сталкиваюсь с проблемой, когда заказчик требует для завершения работ и оплаты гонорара инструкцию для своих сотрудников, где было бы подробно и доходчиво описано, как надо работать с новым модулем. Еще несколько лет назад я всячески пытался "спрыгнуть" с этой темы, мол "все и так понятно", "я всем все объяснил" и т.д., но когда заказчика это не устраивало, я открывал ноутбук и тренировал клавишу "PrtSc" - делал снимок экрана, вставлял его в инструкцию, стрелочками с комментариями объяснял что надо делать, и как реагировать на поведение форм 1С. Процесс отнимал кучу времени и убивал желание работать с этим клиентом в дальнейшем.
Но однажды я открыл для себя технологию, которая все перевернула - и вот, на протяжении последних нескольких лет ВСЕ свои разработки снабжаю подробными и понятными инструкциями, это занимает несколько минут (т.е. для меня практически ничего не стоит), а заказчик получает дополнительный сервис, который выгодно отличает меня от конкурентов.
Кратко идея такая: надо сделать видео-инструкцию по работе с новым функционалом, выложить ее так, чтобы пользователь мог ее просмотреть по ссылке.
Замечания по реализации:
- принцип "одного окна" - инструкция должна открываться непосредственно из 1С
- канал youtube не подходит - сотрудники клиента "Пупкин и Ко" будут видеть инструкции сотрудников "Ромашка ООО", что не просто "не хорошо", но даже опасно для моего здоровья.
- для большого проекта надо сделать много коротких видео-инструкций (до 3мин) и как-то их упорядочить для быстрого поиска пользователем
- надо сделать так, чтобы доступность каждой инструкции определялась ролями данного сотрудника
- нужна возможность обновления инструкций, когда в процессе эксплуатации модуля что-то пришлось переделать и изменилась методика работы пользователя
- у крупных заказчиков зачастую есть свой отдел обучения сотрудников - было бы очень круто, если бы они самостоятельно могли генерировать новые инструкции и "заряжать" их в систему.
Исходя их этих тех.требований, которые я сам для себя сформулировал, я разработал две методики: одна подходит, если заказчику нужна внешняя или встроенная обработка/отчет (т.е. микро-проект) и вторая - если речь идет о более-менее большом модуле, вплоть до внедрения самописной конфигурации "с 0".
Процесс записи инструкции тривиален - запускаю Bandicam, настраиваю окно захвата, чтобы была видна только 1С, включаю запись, показываю на экране как должен работать пользователь (клики мышки подсвечиваются) и голосом объясняю что и как надо делать. После остановки записи Bandicam сохраняет avi-файл в каталоге "Documents\Bandicam\". Далее я даю файлу удобное для меня имя и копирую файл на свой гугл-диск. В настройках доступа ставлю "доступен пользователям, у которых есть ссылка". Инструкция готова. Осталось вставить ее в форму 1С.
Для микро-проекта вставляю ссылку на саму форму отчета/обработки. Для пользователя это выгладит так:
"Просмотр инструкции" - это кнопка, у которой "Вид" = "Гиперссылка". Команда, которая выполняется на кнопке:
Все. Итого на создание 3-минутной инструкции я потратил 4 минуты.
Для большого проекта все немного сложнее:
1. Надо создать иерархический справочник "ВидеоСправка". Кроме стандартных полей "Код", "Наименование" добавляю реквизит "СсылкаНаВидео" (тип - строка неограниченной длины)
2. На форме элемента справочника располагаю эти элементы так:
Здесь реквизит "СсылкаНаВидео" выведен на форму два раза: один как строка (туда я буду вставлять ссылки на видео) и как поле html-документа (тут автоматически будет стартовать просмотр видео)
3. Что бы оградить любопытных пользователей от соблазна заменить мои уроки на видео с ресурса pornohab, делаю строковое поле видимым только администраторам.
4. Настраиваем права на справочник: у администратора полные права, у всех остальных - только просмотр
Это минимально необходимый функционал для старта. Дальше можно добавлять разные фичи, о которых ниже:
На мой взгляд, это не сложная конфигурация. Здесь работается только со справочниками и регистрами сведений. Дерево метаданных конфигурации содержит около 105 справочников, около 150 регистров сведений, а всего 7 документов и один регистр накопления оборотов для учета рабочего времени пользователей. Любая конфигурация из линейки ERP решений ( УТ 11,, ЗУП 3.0, БП 3., КА 2.0 и т. д) на порядок сложнее.
В этой статье я рассматриваю работу с функционалами подсистем НСИ и Учет времени , Документы и файлы, Настройка и администрирование , ( См рис 1).
Рис 1 Подсистемы конфигурации 1С:Документооборот КОРП. Ред. 2.1
1. Объекты подсистемы ( раздела) НСИ
Из всех объектов раздела Нормативно- справочной информации (НСИ) , показанных на рис 2 интерес представляют по своей функциональности следующие объекты:
2. Объекты раздела Документы и файлы
Объекты раздела этого раздела ( Рис 3), функциональность которых представляют для меня интерес таковы :
В комплект поставки уже входит 55 шаблонов типовых инструкций, которые можно редактировать, адаптировать под специфику предприятия и использовать как основу для создания новых материалов. Например, при открытии карточки внутреннего документа можно узнать о том, когда используется выбранный документ и как его составить. При создании процесса программа подскажет, как правильно сформулировать его название, как изложить текст, напомнит о необходимости указать срок. Инструкции помогают выработать единый стандарт работы с документами в организации.
3. Обработка Установка типовой методики документооборота
Из всех обработок подсистемы Настройка и администрирование интерес представляет обработка Установка типовой методики документооборота. Все остальные остальные являются стандартными из БСП ( Библиотека стандартных подсистем) .
Обработка рекомендуется запускать в пустую базу для ее наполнения. При установке в заполненную базу уже имеющиеся данные будут дополнены новыми. Данная обработка ускоряет процесс настройки базы данных. По данным партнеров фирмы «1С» , в среднем настройка и наполнение информационной базы на внедрении требуют 100 часов работы квалифицированного специалиста . Благодаря запуска этой обработки самостоятельно организовать документооборот предприятия с нуля и тут же приступить к работе.
Описание загружаемых данных в информационную базу при запуске обработки можно посмотреть в документации , например, структура предприятия, справочники попок, ролей и рабочих групп с настроенными правами доступа, 62 шаблонов документов, соответствующим требованиям ГОСТов и т. д
4 . Порядок работы с документами
4.1 Виды документов
Вид документа – это реквизит, который по умолчанию является обязательным при регистрации любого входящего, исходящего или внутреннего документа. Виды используются:
- для генерации регистрационных номеров,
- ограничения доступа к документам,
- настройки дополнительных реквизитов документов,
- назначения шаблонов процессов (видам документов).
Деление видов документов на входящие, исходящие и внутренние весьма условно. Согласно типовой методике документооборота Внутренними документами являются акты, договоры, соглашения, заявления, приказы, жалобы и т д. Хотя. могут быть также входящие заявления и коммерческие приложения.
4.2. Настройка вида документа
Установка настроек вида документа выполняется на закладке Вид документа – Настройки карточки вида документа. В справочной информации можно прочитать описание общих настроек для всех видов документов на примере видов внутренних документов.
Рис 4 Закладка Настройка формы справочника ( карточка) вида документа
Особое внимание имеет параметр Является договором – настройка означает, что документы этого вида являются договорами и при установке этой настройки автоматически устанавливаются без возможности отключения другие настройки, как показано на рис. 4
4.3. Настройка нумерации документов
Настройки нумерации определяют правила формирования регистрационного номера входящих, исходящих и внутренних документов. Нумератор привязывается к одному или нескольким видам документов и предусматривает гибкие настройки формата регистрационного номера. Формат номера и другие настройки нумераторов определяются правилами делопроизводства, принятыми на предприятии.
Для создания и настройки правил формирования нумераторов предусмотрен справочник Нумераторы . Справочник открывается по одноименной команде в меню раздела Нормативно-справочная информация ((см рис 5)
Рис 5 Форма элемента справочника Нумераторы
На закладке Формат номера можно выбрать одно или несколько служебных полей для отображения. Формат регистрационного номера может включать в себя различные служебные поля, отмеченные квадратными скобками, и разделители (например, тире, косая черта). Если разделитель помещен в квадратные скобки, внутри которых указано служебное поле, то он будет добавлен к номеру только в том случае, если будет добавлено служебное поле.
После создания и установки формата нумератора необходимо привязать его к одному или нескольким видам документов. Это можно сделать как в карточке нумератора (на закладке Действует для ( рис 5 ), так и в карточке вида документа на закладке Нумерация ( рис 4) .
Для одного вида документа можно указать независимую нумерацию на закладке независимая нумерация по следующим по разрезам как показано на рис 6
Рис 6 Настройка независимой нумерации
Независимая нумерация по организации позволит документам вида, которому назначен этот нумератор, иметь регистрационный номер одного формата, но с индивидуальной нумерацией по каждой организации.
4.3.1 Независимая нумерация по связанному документу
Этот функционал имеет очень практическое применение. Независимая нумерация по связанному документу необходима, например, если в программе регистрируется договор, а затем несколько Дополнительные соглашения или акты к нему и нужно, чтобы доп соглашения или акты имели нарастающую нумерацию в пределах этого договора.
Для установки нумерации по связанному документу необходимо:
- Открыть карточку нумератора на закладке Независимая нумерация .
- Выбрать разрез По связанному документу .
- В открывшемся окне выбора типа связи указать или создать необходимый тип связи. Например, если нумератор настраивается для вида документа Акта на оказание услуг , который должен иметь нумерацию договора, необходимо выбрать тип связи Относится к договору .
4.4. Настройка шаблонов документов
При создании документа в программе предусмотрена возможность автоматически заполнить его реквизитами и присоединить файлы по заранее настроенному шаблону.
При создании вида документа удобно сразу добавить к нему шаблон документа и настроить автоматическое заполнение файлов. Эти настройки доступны в карточке вида документа на закладке Шаблон документа ( см рис 8)
Накладке Реквизиты документа можно создавать наименование документа по шаблону
Рис 8 Создание шаблона наименования документа
При изменении реквизита, участвующего в шаблоне наименования, он автоматически изменится в наименовании документа. Например, измененный регистрационный номер документа автоматически изменится и в наименовании.
Настройка автозаполнения шаблона выполняется в карточке вида документа на закладке Шаблон документа – Файлы по ссылкам Не настроено или Открыть .
Рис 9 Настройка автоматического заполнения файла
При настройке автоматического заполнения шаблонов файлов формата Doc , Docx , Dot , Dotх в открывшейся карточке достаточно отметить нужные поля на закладке Реквизиты , и программа автоматически создаст их в файле.
Рис 10 Выбор реквизитов для автоматического заполнения файла
Помимо основных и дополнительных реквизитов для замены можно указать любые другие данные. Для этого на закладке Скрипты указываются выражения на встроенном языке, на результаты которых будут заменены выбранные поля файла.
Рис 11 Настройка скриптов для автозаполнения файла
Обратите внимание на некоторые особенности настройки скриптов:
- Выражение обязательно должно присваивать значение переменной РезультатОбработки. В противном случае результат его выполнения не будет вставлен в файл.
- Для автозаполнения ФИО пользователей в шаблоне необходимо выбрать реквизит ПредставлениеВДокументах. Если заполнения реквизита ПредставлениеВДокументах не произошло, необходимо проверить, заполнено ли соответствующее поле в карточке пользователя.
Приведем еще несколько примеров выражений на встроенном языке для настройки скриптов.
Для заполнения должности контактного лица получателя:
Для заполнения почтового адреса контрагента-получателя:
Для склонения автозаполняемых ФИО можно обратиться к функции Просклонять.
Функция Просклонять расположена в модуле СклонениеПредставленийОбъектов и для работы использует подключение к внешней библиотеке namedecl.dll.
При этом результат скрипт будет выглядеть следующим образом:
Рис 12 Выражение для склонения ФИО пользователя
4. 5 Настройка учета сторон и учета внутренних документов по контрагентам
В программе есть возможность вести учет внутренних документов по контрагентам или вести учет сторон. Для этого в карточке вида внутреннего документа предусмотрены взаимоисключающие настройки Вести учет по контрагентам и Вести учет сторон .
Вести учет по контрагентам – если настройка включена, то в реквизитах карточки документа можно указать одного или нескольких контрагентов. Для этого в карточке документа этого вида появятся поля Контрагент (обязательное для заполнения), Контактное лицо контрагента , Подписал
После создания новой базы в «1С:Документооборот», необходимо выполнить ее настройки. Установка общих настроек выполняется по команде Настройка программы в меню раздела Настройка и администрирование.
Все настройки программы распределены по закладкам:
Рисунок 1 - Форма окна настроек
1. Настройки на вкладке «Общие настройки»
Рисунок 2 - Форма общих настроек
1.1 Поле Заголовок программы - необходимо указать заголовок программы.
1.2 Настройка Версионирование объектов - если настройка включена, то в программе появится возможность автоматически сохранять историю изменения реквизитов объектов.
1.3 Настройка Дополнительные реквизиты и сведения - если настройка включена, то администратор получает возможность настраивать дополнительные реквизиты и сведения, а пользователи смогут размещать дополнительные реквизиты в карточках документов, настраивать обязательные для заполнения дополнительные реквизиты.
1.4 Настройка Инструкции - настройка делает доступными специальные инструкции, облегчающие знакомство и работу с программой.
1.5 Настройка Электронные подписи - если настройка включена, то документы можно будет удостоверять электронной подписью.
1.6 Остальные настройки оставляем по умолчанию.
2. Настройки на вкладке «Права доступа»
Рисунок 3 - Форма настроек прав доступа
2.1 Настройка Ограничивать права доступа - если настройка включена, то права пользователей «1С:Документооборота» можно ограничивать. Если настройка не установлена, все пользователи по умолчанию получают неограниченный доступ ко всем данным программы.
2.2 Настройка Отложенное обновление прав доступа - если настройка включена, то все задания на обновление прав попадают в специальную очередь, которая автоматически обрабатывается на сервере регламентными заданиями в фоновом режиме, не мешая работе пользователей.
2.3 Остальные настройки оставляем по умолчанию.
3. Настройки на вкладке «Делопроизводство»
Рисунок 4 - Форма настройки работы с документами
3.1 Настройка Виды внутренних документов - если настройка включена, то в карточке внутреннего документа появляется обязательное для заполнения поле Вид. Также при установке этого флажка ответственному за ведение нормативно-справочной информации становятся доступны возможности создания и изменения видов внутренних документов.
3.2 Настройка Категории для документов и файлов - настройка определяет видимость всех отчетов, карточек и элементов управления, связанных с категориями данных.
3.3 Настройка Связи документов - если настройка включена, то в карточках документов появляется возможность настройки перекрестных ссылок документов друг на друга.
3.4 Настройка Учет по организациям - если настройка включена, то программа будет вести учет всех ключевых данных в разрезе нескольких организаций.
3.5 Остальные настройки оставляем по умолчанию.
4. Настройки на вкладке «Работа с файлами»
Рисунок 5 - Форма настройки работы с файлами
4.1 Настройка Хранить файлы в томах на диске - если настройка включена, то файлы, прикрепленные к карточкам документов, будут сохраняться не в информационной базе, а в файловом хранилище на выделенном для этих целей сервере. По ссылке Тома хранения файлов настраиваются тома.
Рисунок 6 - Форма списка томов хранения файлов
Для создания нового тома хранения файлов необходимо в форме списка томов нажать кнопку «Создать» и в открывшемся окне заполнить следующие данные:
4.1.1 Поле Наименование тома - необходимо указать наименование тома хранения данных.
4.1.2 Поле Полный путь - необходимо указать путь к файловому ресурсу, куда будут сохраняться файлы.
Рисунок 7 - Форма элемента
4.2 Настройка Настройка автоматической загрузки файлов - выполняется настройки для выполнения автоматической загрузки файлов из указанного каталога в локальной сети. По настроенному расписанию файлы или папки файлов переносятся из каталога в нужную папку ЭА с сохранением оригинальных имен и структуры подпапок.
Рисунок 8 - Форма настройки загрузки файлов
Для настройки автоматической загрузки файлов необходимо нажать кнопку Добавить и указать следующие данные:
4.2.1 Каталог для загрузки можно указать как в формате Microsoft Windows (UNC путь вида \\server\resource), так и для Linux (путь вида \home\shared). У учетной записи, под которой запускается сервер «1С:Предприятия», должны быть права на чтение файлов в загружаемом каталоге.
Далее необходимо указать папку информационной базы для загрузки и ввести имя пользователя, который будет подставлен в качестве автора новых файлов.
Настроить расписание. В окне перейти по гиперссылке Расписание не задано и в открывшемся окне Расписание задать расписание выполнения загрузки файлов.
Рисунок 9 - Форма настройки расписания выполнения регламентного задания
4.3 Настройка Использовать папки файлов - если настройка включена, то пользователям будет разрешена работа не только с файлами входящих, исходящих и внутренних документов, но и с обычными файлами, доступными при помощи команды Файл на панели навигации раздела Документы и файлы. Права отдельных пользователей на те или иные папки файлов настраиваются непосредственно в папках.
4.4 Остальные настройки оставляем по умолчанию.
5. Настройки на вкладке «Обмен данными»
Рисунок 10 - Форма настройки обмена данными
5.1 Настройка Использовать синхронизацию данных - если настройка включена, то подразумевается использование синхронизации данных с другими конфигурациями или между узлами распределенной информационной базы.
5.2 Настройка Префикс информационной базы - указывается префикс узла текущей информационной базы.
5.3 Настройка Использовать обмен электронными документами - при включении этой настройки у пользователя появляется возможность обмениваться электронными документами через 1С-ЭДО.
Читайте также: