Глава 1. Как пользоваться документацией и справкой

Документация на систему "Corporate" представлена в нескольких вариантах:

печатная документация в формате PDF;
контекстная справка в формате JAR.

Печатная документация и справка системы имеют имеет следующие особенности:

Комплекты по ролям пользователей. Для каждой типовой роли пользователя разрабатывается отдельное руководство пользователя в формате PDF. Соответственно, при изучении печатной документации прежде всего необходимо определить, какое из руководств соответствует Вашей роли в автоматизируемых процессах.
Уровни описания. Содержимое печатной документации и справки поделено на разделы исходя из вида представленной информации. Порядок разделов – от общего к частному. Основными разделами являются:
- Общее описание системы. Раздел содержит концептуальную информацию об архитектуре и принципах функционирования системы как в целом, так и по отдельным подсистемам и компонентам. В этом разделе Вы найдете подробное описание сущностей, которыми оперирует система, связей между объектами, информацию о том, кто, когда, зачем и какие действия в целом выполняет в системе. Раздел рекомендуется как для первичного ознакомления с системой, так и для углубленного изучения особенностей работы системы.
  
  В разделе присутствуют ссылки на все необходимые инструкции, регламенты, и т.д. (см. ниже).
- Регламенты работы с системой. Раздел содержит перечень типовых технологических задач, возникающих в ходе работы с системой, и методов их решения. Решение каждой задачи оформлено в виде операций и процедур, сгруппированных в регламенты. Регламенты служат путеводителем по приведенным в документации инструкциям (см. ниже) и разъясняют, какие пользователи в каких случаях и в каком порядке должны выполнять описанные в инструкциях действия. Также регламенты могут рассматриваться в качестве "быстрого старта" при изучении системы.
  
  Регламенты описывают процессы в целом и не содержат явного упоминания элементов интерфейса – данная детализация приведена в инструкциях (см. ниже).
  
  Каждый регламент целиком охватывает определенный выполняемый в системе технологический процесс, например, процесс установки, процесс начальной настройки, процесс принятия клиента на обслуживание и т.д. Полный перечень регламентов приведен в гл. 3 «Регламенты работы с системой».
- Инструкции по работе с системой. Раздел содержит подробные инструкции по выполнению отдельных действий над объектами системы, например, по созданию документа, наполнению того или иного справочника и т.д.
  
  Представление о том, кто, зачем, когда и в каком порядке должен выполнять описываемые инструкции, дают регламенты по работе с системой и общее описание системы (см. выше).
- Часто задаваемые вопросы. Данный раздел содержит ответы на вопросы, которые могут возникнуть при изучении системы.
- Описание версий системы. Данный раздел содержит описание версий системы с указанием нововведений в каждой версии и ссылок на описание процессов обновления системы до требуемой версии.

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

	Внимание!
В случае использования ПО Adobe Reader при изучении документации формата PDF для перехода по ссылкам назад и вперед, как и в веб-браузерах, можно использовать сочетания клавиш Alt+влево и Alt+вправо. С помощью клавиш Alt+влево Вы можете быстро вернуться к фрагменту, с которого только что перешли по ссылке.

Внимание!

В случае использования ПО Adobe Reader при изучении документации формата PDF для перехода по ссылкам назад и вперед, как и в веб-браузерах, можно использовать сочетания клавиш Alt+влево и Alt+вправо. С помощью клавиш Alt+влево Вы можете быстро вернуться к фрагменту, с которого только что перешли по ссылке.

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

Несколько рекомендаций по поиску интересующей Вас информации в документации формата PDF:

Если Вы хотите ознакомиться с принципами функционирования системы в целом или хотите изучить особенности работы определенной функциональности, не вдаваясь в описание элементов интерфейса, или же не знаете, с чего начать, начните с гл. 2 «Общее описание системы».
Если Вы хотите выполнить определенный технологический процесс, например, провести настройку системы или принять клиента на обслуживание, обратитесь к гл. 3 «Регламенты работы с системой».
Если Вам нужно только уточнить, как выполнить то или иное действие над определенным объектом, например, документом, записью, файлом, не сильно погружаясь в принципы работы системы, откройте гл. 4 «Инструкции по работе с системой».
Если Вы затрудняетесь с определением раздела, содержащего интересующую Вас информацию, воспользуйтесь функцией поиска печатной документации.


Контекстно-зависимая справка системы Corporate		Глава 2. Общее описание системы