Тип вид документа руководство по

50 Виды программных документов.

К программным относят документы,
содержащие сведения, необходи­мые для разработки, сопровождения и эксплуатации
программного обеспе­чения. Документирование программною обеспечения
осуществляется в со­ответствии с Единой системой программной документации (ГОСТ
19.XXX). Так
ГОСТ 19.101-77 устанавливает виды программных документов для про­граммного
обеспечения различных типов. Ниже перечислены основные про­граммные документы
по этому стандарту и указано, какую информацию они должны содержать.

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

Ведомость держателей подлинников
(код вида документа — 05) должна содержать список предприятий, на которых
хранятся подлинники программ­ных документов. Необходимость этого документа определяется
на этапе раз­работки и утверждения технического задания только для программного
обес­печения со сложной архитектурой.

Текст программы
(код вида документа — 12) должен содержать текст программы с необходимыми
комментариями. Необходимость этого докумен­та определяете я на папе разработки
и утверждения технического задания.

Описание программы (код вида
документа -13) должно содержать сведения о логической структуре и
функционировании программы. Необходимость данного документа также определяется
на этапе разработки и утверждения технического задания.

Ведомость эксплуатационных документов
(код вида документа — 20)  должна
содержать перечень эксплуатационных документов на программу, к которым
относятся документы с кодами: 30, 31, 32, 33, 34. 35. 46. Необходимость этого
документа  также определяется на этапе
разработки и утверждения технического задания.

Формуляр (код вида документа —
30) должен содержать основные характеристики ПО, комплектность и сведения об
эксплуатации программы.

Описание применения (код вида
документа — 31) должно содержать сведения о назначении программного
обеспечения, области применения, применяемых методах, классе решаемых задач,
ограничениях для применения, ми­нимальной конфигурации технических средств.

Руководство системного программиста
(код вида документа — 32) должно содержать сведения для проверки, обеспечения
функционирования и настройки программы на условия конкретного применения.

Руководство программиста (код
вида документа — 33) должно содер­жать сведения для эксплуатации программного
обеспечения.

Руководство оператора (код вида
документа — 34) должно содержать сведения для обеспечения процедуры общения
оператора с вычислительной системой в процессе выполнения программного
обеспечения.

Описание языка (код вида
документа — 35) должно содержать описание синтаксиса и семантики языка.

Руководство по техническому обслуживанию
(код вида документа — 46) должно содержать сведения для применения тестовых и
диагностических программ при обслуживании технических средств.

Программа и методика испытаний
(код вида документа — 51) должны содержать требования, подлежащие проверке при
испытании программного обеспечения а также порядок и
методы их контроля.

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

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

Код вида документа указывается в
его децимальном номере, например:

42333253.00037-01 34 01
(руководство оператора).

Допускается объединять отдельные виды эксплуатационных
документов, кроме формуляра и ведомости.  
Необходимость объединения указывается в техническом задании, а имя берут
у одного из объединяемых документов. Например, в настоящее время часто используется
эксплуатационный до­кумент, в который отчасти входит руководство системного
программиста, программиста и  оператора.
Он называется «Руководство пользователя».

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

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

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

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

-учитывайте интересы
пользователей — руководство должно содержать все инструкции, необходимые
пользователю;

-излагайте ясно, используйте
короткие предложения;

-избегайте технического жаргона
и узко специальной терминологии, ес­ли все же необходимо использовать некоторые
термины, то их следует пояс­нить;

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

Руководство пользователя, как правило, содержит следующие
разделы:

-общие сведения о программном
продукте;

-описание установки;

-описание запуска;

-инструкции по работе (или
описание пользовательского интерфейса);

-сообщения
пользователю.

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

Раздел Установка обычно содержит
подробное            описание действий по
установке программного продукта и сообщений, которые при этом могут быть
получены.

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

Раздел Инструкции по работе обычно
содержит описание режимов работы, форматов ввода-вывода информации и возможных
настроек.

Раздел Сообщения пользователю должен
содержать перечень возможных сообщений, описание их содержания и действий,
которые необходимо предпринять по этим сообщениям.

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

По ГОСТ 19.503-79 руководство
системного программиста должно содержать всю информацию, необходимую для
установки ПО, его настройки и проверки работоспособности. Кроме того в него часто включают и описание необходимого
обслуживания, которое раньше приводилось в руководстве оператора (ГОСТ
19.505-79) и/или руководстве по техническому обслуживанию (ГОСТ 19.508-79). В
настоящее время данную схему используют для составления руководства системному
администратору.

Руководство системного
программиста должно содержать следующие разделы:

-общие сведения о
программе;

-структура
программы;

-настройка;

-проверка;

-дополнительные
возможности;

-сообщения
системному программисту.

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

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

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

В разделе Проверка программы
должно быть приведено описание способов проверки работоспособности программы,
например контрольные примеры.

В разделе Дополнительные возможности
должно быть приведено описание дополнительных возможностей программы и
способов доступа к ним.

В разделе Сообщения системному
программисту должны быть указаны тексты сообщений, выдаваемых в ходе
выполнения настройки и проверки программы, а также в ходе ее выполнения,
описание их содержания и действий, которые необходимо предпринять по этим
сообщениям.

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

В системе 1С Документооборот все документы делятся на 3 основных вида: внутренние, входящие и исходящие, которые доступны в разделе «Документы и файлы». Входящие и исходящие документы используются для переписки с другими организациями, внутренние — для ведения документации своей организации (или нескольких своих организаций).

Настройка видов документов доступна в разделе «Нормативно-справочная информация» по ссылке «Виды документов».

Виды документов разделены на три группы вкладками «Внутренние документы», «Входящие документы» и «Исходящие документы». Для удобства использования виды документов можно разделять на группы. Чтобы создать новый вид документа, нажимаем «Создать».

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

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

Рассмотрим подробнее каждый из доступных реквизитов:

• «Использовать срок исполнения» — если этот вид документа подразумевает исполнение, (как, например, приказ) то могут понадобиться данные по срокам, которые можно будет увидеть в карточке документа, не открывая приложенный к документу файл.
• «Использовать гриф утверждения» — при включенной опции, документам такого вида будет доступен статус «Утвержден». Проставляется статус в результате отправки «На утверждение» ответственному должностному лицу.
• «Использовать подписание должностным лицом» — при включенной опции, документам будет доступен статус «Подписан», а также будет проставляться должностное лицо, подписавшее этот документ. Проставляется данный статус в результате отправки «На подписание» ответственному должностному лицу, либо вручную в документе.
• «Вести учет по номенклатуре дел» — если в организации используется ведение учета документов по номенклатуре дел, то включаем данную опцию, заполняем номенклатуру дел, а в документах будет обязательна к указанию номенклатура дел.
• «Вести учет по организациям» — в документах будет доступен выбор организации к которой относится документ.
• «Вести учет по контрагентам» — в документах будет доступен выбор контрагента.
• «Вести учет сторон» — включает выбор сторон: указание контрагента, его роли, выбор лица, подписавшего данный документ со стороны контрагента, а также проставление аналогичных данных со стороны нашей организации.
• «Вести учет по адресатам» — в документах будет выбираться адресат.
• «Учитывать срок действия» — в документе будет указываться срок действия. Актуально для договоров.
• «Учитывать сумму документа» — включает проставление суммы документа.
• «Вести учет товаров и услуг» — добавляет табличную часть товаров и услуг в документ.
• «Вести учет по статьям ДДС» — включает проставление статей ДДС в документе.
• «Учитывать недействующие документы» — если установлен, то документы данного вида могут быть отменены или расторгнуты. При установке в карточке документа появляется флаг «Не действует» и ссылка на документ, который делает его не действующим.
• «Является договором» — включает сразу несколько опций, необходимых для учета договоров: «Вести учет по контрагентам», «Учитывать срок действия», «Учитывать сумму документа», «Учитывать недействующие документы» и сбрасывается признак «Является комплектом документов».
• «Является комплектом документов» — признак означает, что документы с этим видом являются комплектами других документов и файлов. Установить его можно при условии что не установлен ни один из признаков: Является договором, Вести учет по номенклатуре дел, Учитывать срок действия, Учитывать недействующие документы.
• «Обязателен файл скан-копии оригинала» — в списке файлов появляется столбец, в котором можно указать, что данный файл является скан-копией оригинала. Если данный флажок не будет проставлен ни одному из прикрепленных файлов, то при попытке регистрации система предупредит, что скан-копия не прикреплена к документу.
• «Обязательно указание ответственного» — включение проверки на заполнение реквизита «Ответственный».
• «Использовать этапы обработки документов» — для документов будет доступна таблица с указанием этапов обработки документа. При прохождении определенного этапа, пользователь проставляет отметку о выполнении этапа, заполняется дата выполнения. Эта опция удобна для отслеживания документов, находящихся на определенном этапе обработки.
• «Автоматически вести состав участников рабочей группы» — в случае если пользователь отсутствует в рабочей группе документа, но ему отправили задачу на согласование документа (или исполнение и т.д.), то система автоматически добавит данного пользователя в рабочую группу документа.
• «Заполнение рабочей группы является обязательным» — для документов соответствующего вида рабочая группа заполняется автоматически при записи вида документа.
• «Подписывать резолюции электронной подписью» — включает использование электронной подписи при проставлении резолюции.

Для добавления дополнительных свойств перейдем по ссылке «Набор дополнительных свойств документов данного вида».

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

Для добавления нового дополнительного свойства нажимаем правой кнопкой мыши, выбираем «Добавить» — «Новый».

Задаем наименование реквизита, указываем «Тип значения» путем выбора из списка. Если «Тип значения» оставить «Дополнительное значение», то на вкладке «Значения» можно задать список доступных для выбора значений.

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

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

На вкладке «Реквизиты документа» доступны значения реквизитов по умолчанию. Можно задать правило присвоения наименования документа по введенным реквизитам, выбрать организацию, которая будет проставляться в данном виде документов по умолчанию.

Также на вкладке «Реквизиты документа» можно задать папку, в которую будет по умолчанию сохраняться документ, подразделение, ответственный и другие реквизиты.

В разделе «Файлы» можно добавить файлы, которые будут заполняться реквизитами, введенными в документ. Удобно для использования с договорами: в документ достаточно ввести реквизиты, а система сама сформирует файл договора по шаблону. Для настройки заполнения шаблона файла нажимаем на значение в колонке «Настройка заполнения».

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

После нажатия на кнопку «Готово», открывается редактор файла, в котором созданы гиперссылки, вместо которых будут стоять в документе выбранные реквизиты. Данные гиперссылки можно переместить в нужные места документа, отредактировать формат. Сохраняем отредактированный шаблон, закрываем файл.

Когда документ открывается для редактирования, он становится недоступным для изменения другим пользователям. До тех пор пока редактирующий не нажмет «Закончить», введенные настройки не будут применены. Чтобы проверить как сработали настройки, можно нажать «проверить настройку заполнения» и выбрать документ на основе которого будет заполнен шаблон.

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

Как оптимизировать работу с программой?

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

Для того, чтобы обновления происходили без проблем, а на все вопросы вы могли получать ответы, предлагаем обратиться за сопровождением 1С к профессионалам, в компанию «ПРОГРАММЫ 93».

Почему нас выбирают?

ООО «ПРОГРАММЫ 93» — это компания с большим штатом сотрудников, в который входят не только специалисты 1С, но и бухгалтера, юристы и множество других экспертов смежных областей. Вы больше не зависите от одного сотрудника и вам не нужно тратить деньги на приглашенных специалистов для решения каждой задачи.

Мы рады предложить вам:

• внедрение и настройку 1С Документооборот;
• доработку программы под ваши нужды;
• поддержку продуктов 1С;
• интеграцию программы с сайтом;
• внедрение других продуктов 1С;
• сопровождение бухгалтерского и налогового учета.

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

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

Документирование — это важная часть в разработке программного обеспечения, но часто ей уделяется недостаточно внимания.

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

Данный процесс состоит из шести работ. Общее число задач по данным работам равно 6.

Источник:

Виды программных документов

ЕСПД устанавливает
следующие вида программных документов:

• спецификацию,
  содержащую состав программы и
  документацию на нее;

• ведомость
  держателей подлинников – перечень
  предприятий, на которых хранят подлинники
  программных документов;

• техническое
  задание, определяющее требования к
  программе, необходимые стадии и сроки
  разработки, виды испытаний;

• пояснительную
  записку, содержащую общее описание
  алгоритма и функционирования программы;

• программу
  и методику испытаний, содержащие
  требования, подлежащие проверке при
  испытании программы, а также порядок
  и методы их контроля;

• описание
  программы – сведения о логической
  структуре и функционировании программы;

• текст
  программы – запись программы с
  необходимыми комментариями;

• эксплуатационные
  документы, которые, в свою очередь,
  содержат:

ведомость
эксплуатационных документов – перечень
эксплуатационных документов на программу;

формуляр –
определяет основные характеристики
программы, комплектность и сведения об
эксплуатации;

описание применения
– содержит сведения о назначении,
области применения программы, методах
и классе решаемых задач;

руководство
программиста – содержит сведения,
необходимые при эксплуатации программ;

руководство
системного программиста – содержит
сведения для проверки, обеспечения
функционирования и настройки программы
на условия конкретного применения;

описание языка –
определяет синтаксис и семантику языка
взаимодействия пользователя с программой;

руководство
оператора – содержит сведения, необходимые
для обеспечения процедуры общения
оператора ЭВМ в процессе выполнения
программы;

руководство по
техническому обслуживанию – содержит
описание применения текстовых и
диагностических программ при обслуживании
технических средств.

Состав
программного документа

Материалы каждого
программного документа необходимо
располагать в такой последовательности:

• лист
  утверждения;

• титульный
  лист;

• аннотация,
  в которой кратко излагают назначение
  и содержание документа;

• содержание,
  текст документа (с рисунками, таблицами
  и т.п.);

• приложения;

• перечень
  ссылочных документов.

Содержание
основных документов

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

Техническое
заданиевключает следующие разделы:

• введение
  – даются наименование и краткая
  характеристика области применения
  программного изделия;

• основания
  для разработки – указываются наименования
  документов, на основании которых ведется
  разработка;

• назначение
  разработки – определяются функциональное
  и эксплуатационное назначение
  программного изделия;

• требования
  к программному изделию – содержит
  подразделы:

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

условия эксплуатации
(условия окружающей Среды, выбор типов
носителей информации, вид обслуживания,
количество и квалификация персонала);

требования к
составу и параметрам технических
средств; к информационной и программной
совместимости (требования к языкам
программирования, программным и
операционным системам);

• требования
  к программной документации – дается
  состав программной документации и
  требования к ней;

• технико-экономические
  показатели;

• стадии
  и этапы разработки – устанавливаются
  необходимые стадии, этапы и содержание
  работ, а также сроки разработки;

• порядок
  контроля и приемки – указываются виды
  испытаний и общие требования к приемке
  работы.

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

• введение;

• назначение
  и область применения;

• технические
  характеристики – содержит подразделы:

постановка задачи,
описание применяемых математических
методов, допущений и ограничений
выбранных математических методов;

описание алгоритма
и функционирования программ с обоснованием
выбора схемы алгоритма;

описание и
обоснование выбора метода организации
входных и выходных данных, состава
технических и программных средств;

• ожидаемые
  технико-экономические показатели.

Программа и
методика испытанийвключает
следующие разделы:

• объект
  испытаний – дается наименование и
  обозначение испытуемой программы;

• цель
  испытаний – указывается цель проведения
  испытаний;

• состав
  предъявляемой документации – приводится
  перечень документации, предъявляемой
  при проведении испытаний;

• технические
  требования – включают подразделы —
  требования к программной документации;
  техническим характеристикам;
  информационной и программной
  совместимости;

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

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

Описание
программывключает следующие
разделы:

• общие
  сведения – указываются наименование
  и обозначение программы, программное
  обеспечение, необходимое для ее
  функционирования, языки программирования,
  на которых написана программа;

• функциональное
  назначение – даются классы решаемых
  задач и сведения о функциональных
  ограничениях на их применение;

• входные
  данные – описываются характер,
  организация и предварительная подготовка
  входных данных, формат и способ их
  кодирования;

• выходные
  данные – приводятся те же сведения,
  что и в разделе “Входные данные”;

• описание
  логической структуры – содержит
  подразделы:

используемые
методы;

структуру программы
с описанием функций составных частей
и связи между ними;

структуру и
организацию данных, используемых в
программе;

алгоритм программы;

связь программы
с другими программами;

• вызов
  и загрузка – указываются способ вызова
  программы с соответствующего носителя
  данных, входные точки в программу,
  сведения об использовании оперативной
  памяти и объем программы;

• используемые
  технические средства – даются типы
  ЭВМ и устройств, которые применяются
  при работе программы.

Текст программысодержит символическую запись программы
на языке программирования с комментариями,
отражающими структуру и назначение
частей программы.

Описание
применения– эксплуатационный
документ, включающий разделы:

• назначение
  программы – указываются назначение,
  возможности программы, ее основные
  характеристики, ограничения, накладываемые
  на область применения программы;

• условия
  применения – формулируются условия,
  необходимые для выполнения программы
  (требования к техническим средствам,
  другим программам, общие характеристики
  входной и выходной информации);

• описание
  задачи – определяется задача и методы
  ее решения;

• входные
  и выходные данные – указываются сведения
  о входных и выходных данных.

Руководство
программиста– эксплуатационный
документ, включающий разделы:

• назначение
  и условия применения программы –
  указываются назначение и функции,
  выполняемые программой, условия,
  необходимые для ее выполнения (объем
  оперативной памяти, требования к составу
  периферийных устройств, требования к
  программному обеспечению и т.п.);

• характеристики
  программы – описываются основные
  характеристики и особенности программы
  (режим работы, средства контроля
  правильности выполнения и т.п.);

• обращение
  к программе – описываются процедуры
  вызова программы, способы передачи
  управления и параметров;

• входные
  и выходные данные – описываются
  организация входной и выходной
  информации, способы ее кодирования;

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

Руководство
оператора(пользователя) –
эксплуатационный документ, включающий
разделы:

• назначение
  программы – приводятся сведения,
  необходимые для понимания функций
  программы и условий ее эксплуатации;

• условия
  выполнения программы – указываются
  условия, состав аппаратных и программных
  средств, необходимых для выполнения
  программы;

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

• сообщения
  оператору – приводятся тексты сообщений,
  выдаваемых в ходе выполнения программы,
  описание их содержания и описание
  действий, выполняемых оператором.