Руководство по инсталляции программного продукта

Пользовательская документация

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

В случае если продуктом является программная библиотека, пользовательская документация и документация на код становятся очень близкими, почти эквивалентными понятиями. Но в общем случае, это не так.

Обычно, пользовательская документация представляет собой руководство пользователя, которое описывает каждую функцию программы, а также шаги, которые нужно выполнить для использования этой функции. Хорошая пользовательская документация идёт ещё дальше и предоставляет инструкции о том, что делать в случае возникновения проблем. Очень важно, чтобы документация не вводила в заблуждение и была актуальной. Руководство должно иметь чёткую структуру; очень полезно, если имеется сквозной предметный указатель. Логическая связность и простота также имеют большое значение.

Существует три подхода к организации пользовательской документации. Вводное руководство (англ. tutorial), наиболее полезное для новых пользователей, последовательно проводит по ряду шагов, служащих для выполнения каких-либо типичных задач. Тематический подход, при котором каждая глава руководства посвящена какой-то отдельной теме, больше подходит для совершенствующихся пользователей. В последнем, третьем подходе, команды или задачи организованы в виде алфавитного справочника — часто это хорошо воспринимается продвинутыми пользователями, хорошо знающими, что они ищут. Жалобы пользователей обычно относятся к тому, что документация охватывает только один из этих подходов, и поэтому хорошо подходит лишь для одного класса пользователей.

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

Документирование программного обеспечения

Когда программист-разработчик получает в той или иной форме задание на программирование, перед ним, перед руководителем проекта и перед всей проектной группой встают вопросы: что должно быть сделано, кроме собственно программы? что и как должно быть оформлено в виде документации? что передавать пользователям, а что — службе сопровождения? как управлять всем этим процессом? Кроме упомянутых вопросов есть и другие, например, что должно входить в само задание на программирование? Прошло много лет, программирование происходит в среде совершенно новых технологий, многие программисты, работая в стиле drag-and-drop, могут годами не видеть текст своих программ. Это не значит, что исчезла необходимость в их документировании. Более того, вопросы о наличии хоть какой-то системы, регламентирующей эту сторону создания программных средств, продолжают задавать постоянно. Спрашивают и о том, есть ли обязательные для применения стандарты (особенно остро стоит этот вопрос, когда разработка выполняется по заказу государственной организации или предприятия). Интересуются и тем, где можно купить имеющиеся стандарты.

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

Техническое задание

Техническое задание. Требование к содержанию и оформлению. Напомним, что техническое задание (ТЗ) содержит совокупность требований к ПС и может использоваться как критерий проверки и приемки разработанной программы.

Поэтому достаточно полно составленное (с учетом возможности внесения дополнительных разделов) и принятое заказчиком и разработчиком, ТЗ является одним из основополагающих документов проекта программного средства.

В зависимости от особенностей разрабатываемого ПО стандарт допускает уточнение содержания разделов, введение новых разделов или их объединение.

Руководство пользователя

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

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

В связи с этим следует различать две категории пользователей: ординарных пользователей программы и администраторов. Ординарный пользователь программы (end-user) использует программу для решения своих задач (в своей предметной области). Это может быть инженер, проектирующий техническое устройство, или кассир, продающий железнодорожные билеты с помощью данной программы. Он может и не знать многих деталей работы компьютера или принципов программирования. Администратор программы (system administrator) управляет использованием программы ординарными пользователями и осуществляет сопровождение программного средства, не связанное с модификацией программ. Например, он может регулировать права доступа к программе между ординарными пользователями, поддерживать связь с поставщиками программы или выполнять определенные действия, чтобы поддерживать программу в рабочем состоянии, если оно включено как часть в другую систему.

Состав пользовательской документации зависит от аудиторий пользователей, на которые оно ориентировано, и от режима использования документов. Под аудиторией здесь понимается контингент пользователей, у которого есть необходимость в определенной пользовательской документации. Удачный пользовательский документ существенно зависит от точного определения аудитории, для которой он предназначен. Пользовательская документация должна содержать информацию, необходимую для каждой аудитории. Под режимом использования документа понимается способ, определяющий, каким образом используется этот документ. Обычно пользователю достаточно больших программных систем требуются либо документы для изучения программного средства (использование в виде инструкции), либо для уточнения некоторой информации (использование в виде справочника).

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

Руководство по инсталляции программного средства

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

Инструкция по применению программного средства

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

Справочник по применению программного средства

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

Руководство по управлению программным средством

Предназначено для системных администраторов. Оно должно описывать сообщения, генерируемые, когда программные средства взаимодействует с другими системами, и как реагировать на эти сообщения. Кроме того, если программное средство использует системную аппаратуру, этот документ может объяснять, как сопровождать эту аппаратуру.

Разработка пользовательской документации начинается сразу после создания внешнего описания. Качество этой документации может существенно определять успех программы. Она должна быть достаточно проста и удобна для пользователя (в противном случае это программное средство, вообще, не стоило создавать). Поэтому, хотя черновые варианты (наброски) пользовательских документов создаются основными разработчиками программного средства, к созданию их окончательных вариантов часто привлекаются профессиональные технические писатели. Кроме того, для обеспечения качества пользовательской документации разработан ряд стандартов, в которых предписывается порядок разработки этой документации, формулируются требования к каждому виду пользовательских документов и определяются их структура и содержание.

Руководство программиста

Документация по сопровождению программного средства (system documentation) описывает программное средство с точки зрения ее разработки.

Эта документация необходима, если программное средство предполагает изучение того, как оно устроена (сконструирована), и модернизацию его программ. Как уже отмечалось, сопровождение — это продолжающаяся разработка. Поэтому в случае необходимости модернизации программного средства к этой работе привлекается специальная команда разработчиков- сопроводителей. Этой команде придется иметь дело с такой же документацией, которая определяла деятельность команды первоначальных (основных) разработчиков программного средства, — с той лишь разницей, что эта документация для команды разработчиков-сопроводителей будет, как правило, чужой (она создавалась другой командой). Команда разработчиков- сопроводителей должна будет изучать эту документацию, чтобы понять строение и процесс разработки модернизируемого программного средства, и внести в эту документацию необходимые изменения, повторяя в значительной степени технологические процессы, с помощью которых создавалось первоначальное программное средство.

Документация по сопровождению программного средства можно разбить на две группы:

1. документация, определяющая строение программ и структур данных ПС и технологию их разработки;

2. документацию, помогающую вносить изменения в программное средство.

Документация первой группы содержит итоговые документы каждого технологического этапа разработки программного средства. Она включает следующие документы:

Документы установления достоверности включают, прежде всего, документацию по тестированию (схема тестирования и описание комплекта тестов), но могут включать и результаты других видов проверки программного средства, например, доказательства свойств программ.

Документация второй группы содержит

Утверждаю

Генеральный директор

ЗАО «НТЦ СТЭК»

_________________ А.А. Верт
«13» апреля 2016 г.

РУКОВОДСТВО ПО УСТАНОВКЕ
программного продукта

(для налогоплательщика)
Программный продукт

Система защищенного документооборота

«СТЭК-ТРАСТ»

версия 2.7, ОС Windows 2000 / XP / 2003/ 7/ 8/ 8.1/ 10

г. Челябинск

2016 г.

В данном документе приведено описание процедуры установки и первоначальной настройки программного продукта «Система защищенного документооборота«СТЭК-ТРАСТ», версия 2.7, OC Windows 2000/XP/2003/7/8/ 8.1/ 10 (программа «СТЭК-ТРАСТ»).
Документ предназначен для пользователей, которые будут самостоятельно устанавливать программу «СТЭК-ТРАСТ».
Программа «СТЭК-ТРАСТ» может быть усовершенствована с того момента, когда был разработан данный документ, поэтому возможны некоторые несоответствия, касающиеся описания пользовательского интерфейса.
Документ разработан специалистами ЗАО «НТЦ СТЭК».

 ЗАО «НТЦ СТЭК», 2016

СОДЕРЖАНИЕ

1. ИНФОРМАЦИЯ О ПРОГРАММЕ

1. Наименование и версия программы

Программный продукт «Система защищенного документооборота «СТЭК-ТРАСТ», версия 2.7, ОС Windows 2000/XP/2003/7/8/ 8.1/ 10 (далее по тексту – программа «СТЭК-ТРАСТ»).

Публикация оригинала – апрель 2004 года.

Публикация текущей версии – апрель 2016 года.

1. Комплект поставки

В комплект поставки программы «СТЭК-ТРАСТ» входит:

• Установочный (инсталляционный) файл программы «СТЭК-ТРАСТ» (setup.exe) 1 штука;
• Информация о программном продукте (для налогоплательщика). Программный продукт «Система защищенного документооборота «СТЭК-ТРАСТ», версия 2.7, ОС Windows 2000 / XP / 2003/ 7/ 8/ 8.1/ 10 1 штука;
• Руководство по установке программного продукта (для налогоплательщика). Программный продукт «Система защищенного документооборота «СТЭК-ТРАСТ», версия 2.7, ОС Windows 2000 / XP / 2003/ 7/ 8/ 8.1/ 10 1 штука;
• Руководство пользователя для налогоплательщика. Программный продукт «Система защищенного документооборота «СТЭК-ТРАСТ», версия 2.7, ОС Windows 2000 / XP / 2003/ 7/ 8/ 8.1/ 10 1 штука;
• Руководство по обеспечению безопасности использования квалифицированной электронной подписи и СКЗИ 1 штука;
• Вид носителя: CD-ROM в количестве (по требованию) 1 штука.

Носитель снабжен информацией (этикеткой), идентифицирующей его принадлежность к программе «СТЭК-ТРАСТ».

1. Изготовитель программы

Полное наименование: Закрытое акционерное общество «НТЦ СТЭК»

Краткое наименование: ЗАО «НТЦ СТЭК»

ИНН: 7451019159

КПП: 745101001

Юридический адрес: 454092, г. Челябинск, ул. Курчатова, д.7.

Почтовый адрес: 454080, г. Челябинск, ул. Энтузиастов, д.12-Б.

Телефон: (351) 729-95-52 факс (351) 729-95-50

E-mail: support@stek-trust.ru

www: http://www.stek-trust.ru

1. Поставщик программы

Получить программу «СТЭК-ТРАСТ» можно загрузив ее с сайта www.stek—trust.ru (раздел «Скачать») или в офисе поставщика ЗАО «НТЦ СТЭК» по адресу: 454080, г. Челябинск, ул. Энтузиастов, д.12-Б. Телефон для справок: (351) 729-95-52. E—mail: support@stek—trust.ru

1. ОБЩИЕ СВЕДЕНИЯ

1. Интерфейс программы

Программа «СТЭК-ТРАСТ» имеет дружественный пользователю и простой в использовании Windows-интерфейс (оконный интерфейс).

1. Требования к пользователям программы

Характер изложения данного Руководства предполагает, что пользователь знаком с операционной системой компьютера, на котором будет установлена программа «СТЭК-ТРАСТ» (Microsoft Windows 2000/XP/2003/7/8/8.1/10) и владеете базовыми навыками работы с ней.

Пользователю должны быть знакомы следующие понятия и навыки:

• использование меню «Пуск» («Start») для вызова программы;
• приемы работы с окнами;
• работа с меню;
• использование управляющих элементов диалогов;
• стандартные диалоги;
• понятие «Буфера обмена» Windows и приемы работы с ним;
• настройка операционной системы с помощью «Панели управления» («Control Panel»).

Если пользователь недостаточно хорошо владеете перечисленными выше понятиями и навыками, рекомендуем обратиться к документации по используемой операционной системе.

1. Авторское право

Ни один раздел данного Руководства не может быть воспроизведен, передан на хранение в информационно-справочную систему, переведен на иностранный или машинный язык целиком или частично, в любой форме или любыми средствами, будь то электронные, механические, магнитные, оптические, ручные или иные, без предварительного письменного разрешения ЗАО «НТЦ СТЭК».

Программное обеспечение содержит ценную информацию, защищаемую Законом об авторских правах, секреты фирмы и информацию, являющуюся собственностью. Все это принадлежит ЗАО «НТЦ СТЭК».

Лицензия распространяется на все программное обеспечение программы «СТЭК-ТРАСТ», за исключением случаев, где это специально оговорено.

Несанкционированное использование документации или программного обеспечения может явиться причиной гражданского иска и преследования в судебном порядке.
 ЗАО «НТЦ СТЭК», 2016

2.4 Системные требования

Для работы программы «СТЭК-ТРАСТ» необходимо (минимальные требования):

• Компьютер с процессором Intel Celeron или более мощным, оперативная память – 256 МБ.
• Операционная система: Windows 2000/XP/2003/7/8/8.1/10.
• 150 MБ свободного места на диске для установки программы (для дальнейшей работы рекомендуется иметь 100-200 MБ свободного пространства).
• Установленное средство криптографической защиты информации (СКЗИ) Верба-OW или КриптоПро CSP.
• Выход в Интернет с рабочего места налогоплательщика на заданный адрес сервера Оператора электронного документооборота (далее — Оператор ЭДО). Настройки осуществляются по http, 80 порту. Способ выхода в Интернет — модемная связь, выделенная линия, ADSL-модем, GPRS-соединение.

Рекомендуемые требования:

• Компьютер с процессором Intel Core 2 Duo или более мощным
• Оперативная память: 2,00 Гб ОЗУ и более
• Операционная система: Windows 2000/XP/2003/7/8/8.1/10.
• 150 MB свободного места на диске для установки программы (для дальнейшей работы рекомендуется иметь 1-10 Гб свободного пространства)
• Установленное средство криптографической защиты информации (СКЗИ) Верба-OW или КриптоПро CSP.
• Выход в Интернет с рабочего места абонента на заданный адрес сервера Оператора ЭДО (настройки осуществляются по http, 80 порту). Способ выхода в Интернет — модемная связь, выделенная линия, ADSL-модем, GPRS-соединение.
• В исключительных случаях могут потребоваться права Администратора.

Формирование и выгрузку отчетов в утвержденном формате пользователь осуществляет с помощью специальных программных средств, которые в поставку программы «СТЭК-ТРАСТ» не входят. К таким средствам относятся, например:

• Программный продукт «СТЭК — Электронная отчетность» актуальной версии и сборки. На момент написания данного документа актуальной была версия от 08.04.2016 г. сборка 205 (разработчик ЗАО «НТЦ СТЭК», распространяется бесплатно).
• Программный комплекс «Налогоплательщик ЮЛ» актуальной версии. На момент написания данного документа актуальной была версия 4.47 от 08.04.2016 г. (разработчик ФГУП ГНИВЦ ФНС России, распространяется бесплатно).

Системные требования к программным продуктам, предназначенным для формирования отчетности в утвержденном формате, порядок установки и работы с программными средствами приведены в документации к соответствующему программному средству и в данном Руководстве не рассматриваются.

1. УСТАНОВКА ПРОГРАММЫ

1. Подготовка к установке программы

Настоящее Руководство описывает процедуру установки и настройки программы «СТЭК — ТРАСТ» на примере операционной системы Windows 7 и, частично, Windows XP. Для других операционных систем внешний вид окон и меню доступа к соответствующим настройкам могут отличаться от описанных в настоящем Руководстве. В случае использования других операционных систем (Windows 2000 / 2003 /2008) пользователь должен руководствоваться документацией по соответствующей операционной системе.

Для установки и настройки программы «СТЭК — ТРАСТ» пользователю необходимо иметь:

• Программное обеспечение и документацию (поставляется на диске или может быть загружено с сайта).
• Закрытые ключи ЭП для работы в системе электронного документооборота ФНС РФ. Закрытые ключи хранятся на ключевых носителях – электронных устройствах (типа eToken или флеш-накопителях).
• Сертификат для работы в системе электронного документооборота. Сертификаты передаются пользователю в удостоверяющем центре на сменных носителях (дискетах или флеш-накопителях).
• Лицензию на бумажном носителе на право использования СКЗИ «Верба – OW» версии 6.1.2 или СКЗИ КриптоПро CSP версии 3.6 или 3.9 от разработчика данного программного обеспечения.

Порядок подготовки к установке программы «СТЭК — ТРАСТ» состоит из нескольких этапов:

1.Установить средство криптографической защиты (СКЗИ) (СКЗИ «Верба – OW» версии 6.1.2 или СКЗИ КриптоПро CSP версии 3.6 или 3.9). Во время установки СКЗИ потребуется указать серийный номер из Лицензии на право использования программного продукта СКЗИ.

Средство криптографической защиты (СКЗИ «Верба – OW» или СКЗИ КриптоПро CSP) необходимо для:

• создания ЭП на документе (с помощью закрытого ключа абонента);
• шифрования / дешифрования документов, подписанных ЭП;
• проверки подлинности ЭП на электронном документе;
• проверки целостности поступивших электронных документов.

ВАЖНО!

Дистрибутив СКЗИ Верба-OW или СКЗИ КриптоПРО CSP является несетевой версией и устанавливается только ЛОКАЛЬНО на рабочее место пользователя.

Пользователю необходимо установить то СКЗИ, на которое у него преобретена лицензия и сертификат. Тип СКЗИ можно уточнить, прочитав Лицензию на СКЗИ, полученную в Удостоверяющем центре ЗАО «НТЦ СТЭК».

2.Установить личный сертификат пользователя – это делается после установки СКЗИ на рабочем месте пользователя.

3.Настроить выход в Интернет – в противном случае отправлять и получать отчетность будет невозможно.

4.Установить программу «СТЭК-ТРАСТ».

1. Установка программы

Для того чтобы можно было работать с программой «СТЭК — ТРАСТ» необходимо установить одно из средств криптографической защиты – «Верба» или «КриптоПро».

ВАЖНО!

Пользователю необходимо установить ту СКЗИ, на которую у него приобретена лицензия и сертификат. Тип СКЗИ можно уточнить прочитав лицензию на СКЗИ, полученную в Удостоверяющем центре ЗАО «НТЦ СТЭК».
Перед тем, как приступить к установке программы «СТЭК — ТРАСТ», следует убедиться в наличии достаточного свободного места на жестком диске.

ВАЖНО!

С рабочего места обязательно должен быть настроен выход в Интернет.

Программа «СТЭК — ТРАСТ» должна быть установлена на локальный диск компьютера.
Программа установки «setup.exe» находится на лазерном компакт-диске. На диске так же находится документация по эксплуатации программного обеспечения (данное Руководство).

Чтобы установить программу «СТЭК — ТРАСТ», необходимо на рабочем месте пользователя запустить лазерный диск, полученный в Удостоверяющем центре ЗАО «НТЦ СТЭК».

После запуска диска необходимо выбрать «Установка Системы «СТЭК — ТРАСТ»»

Будет выполнен запуск Мастера установки программных продуктов ЗАО «НТЦ СТЭК» — СКЗИ «Верба — OW».

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

На следующем шаге предлагается выбрать возможность установки СКЗИ. Если параметр включен (для него установлена галочка), то при переходе к установке будет выполнена установка СКЗИ «Верба — OW». Отключение данного параметра предусмотрено для дополнительной установки недостающих компонентов.

На следующем шаге Мастера установки пользователю предложено выбрать тип установки — Автоматическая (по умолчанию) или Ручная.

При выборе автоматической установки будет выполнена установка всех компонентов, необходимых для работы с выбранным направлением. Если пользователь выберет ручную установку, то пользователю предлагается выбрать дополнительные компоненты для установки.


По завершению установки Мастер установки выдаст сообщение о завершении установки всех выбранных компонентов и по кнопке «Готово» осуществляется выход из приложения.

Установка СКЗИ «КриптоПро CSP» и программ с диска производится аналогичным образом.

1. Рекомендации для настройки межсетевого экрана

Для соединения программы «СТЭК — ТРАСТ» с сервером Оператора ЭДО, при использовании межсетевого экрана необходимо открыть доступ на 80 порт (HTTP) для адреса gpr.stek-trust.ru, т.е. с компьютера, на котором установлена программа «СТЭК — ТРАСТ», должен быть свободный доступ на данный адрес.

Если доступ на сервер Оператора ЭДО открыт, то после того, как пользователь введет в адресной строке Microsoft Internet Explorer адрес: http://gpr.stek-trust.ru/test, откроется тестовая страница сервера.

В случае, если пользователь введет в адресной строке в Microsoft Internet Explorer адрес: http://gpr.stek-trust.ru, появится сообщение «Unknown command».

1. Рекомендации для настройки выделенной линии

Если на рабочем месте пользователя используется прокси-сервер для выхода в Интернет, то при осуществлении сеанса связи (т.е. выхода в Интернет) программа «СТЭК — ТРАСТ» определяет настройки прокси-сервера по настройкам локальной сети из Microsoft Internet Explorer. Если в Microsoft Internet Explorer в меню «Сервис» – «Свойства обозревателя» – «Подключения» – «Настройка LAN» не внесены данные прокси–сервера, необходимо их внести.

В случае, если на рабочем месте пользователя выход в Интернет через прокси-сервер осуществляется по паролю, при осуществлении первого сеанса связи программа «СТЭК — ТРАСТ» выдаст запрос для ввода имени пользователя и пароля. Чтобы программа при каждом выходе в Internet не запрашивала имя и пароль, пользователь может установить галочку в поле «Запомнить и больше не спрашивать».

1. Рекомендации для настройки модемного соединения в OC Windows XP

При настройке модемного соединения в OC Windows XP по умолчанию в «Параметрах оборудования» включено «Аппаратное управление потоком»:

ВАЖНО!

Настройку «Аппаратное управление потоком» убирать нельзя.

1. Настройка модемного соединения в программе

В программе «СТЭК — ТРАСТ» в меню «Сервис» – «Параметры системы» для автоматического вызова модемного соединения в поле «Наименование модемного соединения» можно выбрать имя подключения (если подключений несколько, их можно выбрать из предлагаемого программой списка), см. рисунок. В случае плохого качества связи рекомендуется дополнительно поставить галочку в поле «Оптимизировать параметры для работы по медленным (ненадежным) линиям».

Если пользователь в программе «СТЭК — ТРАСТ» укажет имя модемного подключения, то при выходе на связь с сервером Оператора ЭДО (по кнопке «Отправить / получить») программа автоматически будет осуществлять модемное подключение для выхода в Интернет, а после окончания сеанса связи подключение к Интернету будет автоматически разрываться.