Техническая документация на информационную систему

ВОПРОСЫ К ГОСАМ

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

ОБЩИЕ ПОЛОЖЕНИЯ

1.1. Документация информационного обеспечения АСУ предназначена для описания проектных решений по информационному обеспечению в документах:

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

1.2. При разработке документов на части АСУ содержание разделов каждого документа ограничивают рамками соответствующей части.

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

1.4. Отсутствие проектных решений по разделу документа фиксируют в соответствующем разделе с необходимыми пояснениями.

ТРЕБОВАНИЯ К СОДЕРЖАНИЮ ДОКУМЕНТОВ

Описание информационного обеспечения АСУ

2.1.1. Документ должен состоять из следующих разделов:

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

2.1.2. Требования к содержанию разделов

2.1.2.1. В разделе «Принципы организации информационного обеспечения» должны быть приведены:

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

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

2.1.2.3. В разделе «Построение системы классификации и кодирования» должны быть приведены:

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

2.1.2.4. Раздел «Организация внутримашинной информационной базы» должен содержать описание принципов построения базы, характеристики ее состава и объема, структуры базы на уровне баз данных с описанием характера взаимосвязей баз данных и указанием функций АСУ, при реализации которых используют каждую базу данных, характеристики данных, содержащихся в каждой базе данных.

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

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

Описание системы классификации и кодирования

Документ должен содержать по каждому классифицируемому объекту описание метода кодирования, структуру и длину кода, указание о системе классификации и другие сведения по усмотрению разработчика.

Чертеж формы документа (видеограммы)

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

Описание массива информации

Документ должен содержать:

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

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

Техническая документация

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

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

Часто при составлении технической документации используются автоматизированные средства — генераторы документации, такие как Doxygen, javadoc, NDoc и другие. Они получают информацию из специальным образом оформленных комментариев в исходном коде, и создают справочные руководства в каком-либо формате, например, в виде текста или HTML.

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

Маркетинговая документация

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

· подогреть интерес к продукту у потенциальных пользователей

· информировать их о том, что именно делает продукт, с тем чтобы их ожидания совпадали с тем, что они получат

· объяснить положение продукта по сравнению с конкурирующими решениями

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

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

ОБЩИЕ ПОЛОЖЕНИЯ

1.1. Документация по техническому обеспечению АСУ предназначена для описания проектных решений по техническому обеспечению в документах:

· описание комплекса технических средств;

· структурная схема комплекса технических средств;

· план расположения;

· перечень заявок на разработку новых технических средств;

· перечень заданий заказчику АСУ (Генпроектировщику) на проектирование в смежных частях проекта объекта, связанное с созданием АСУ;

· ведомость оборудования и материалов;

· технические требования к технологическому объекту управления;

· задание на проектирование в смежной части проекта объекта, связанное с созданием АСУ;

· проектная оценка надежности комплекса технических средств;

· принципиальная схема;

· схема автоматизации;

· таблица соединений и подключений;

· схема соединений внешних проводок;

· чертеж общего вида;

· схема подключений внешних проводок;

· спецификация оборудования;

· чертеж установки технических средств;

· ведомость потребности в материалах.

(Измененная редакция, Изм. № 1)

1.2. При разработке документов на подсистему содержание разделов каждого документа ограничивают рамками данной подсистемы.

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

1.4. Отсутствие проектных решений по разделу документа фиксируют в соответствующем разделе с необходимыми пояснениями.

ТРЕБОВАНИЯ К СОДЕРЖАНИЮ ДОКУМЕНТОВ

СОСТАВ И СОДЕРЖАНИЕ

2.1. ТЗ содержит следующие разделы, которые могут быть разделены на подразделы:

• 1) общие сведения;
• 2) назначение и цели создания (развития) системы;
• 3) характеристика объектов;
• 4) требования к системе;
• 5) состав и содержание работ по созданию системы;
• 6) порядок контроля и приемки системы;
• 7) требования к составу и содержанию работ по подготовке объекта разработки к вводу системы в действие;
• 8) требования к документированию;
• 9) источники разработки.

В ТЗ могут включаться приложения.

2.2. В зависимости от вида, назначения, специфических особенностей проекта и условий функционирования системы допускается оформлять разделы ТЗ в виде приложений, вводить дополнительные, исключать или объединять подразделы ТЗ.

В ТЗ на части системы не включают разделы, дублирующие содержание разделов ТЗ в целом.

2.3. В разделе «Общие сведения» указывают:

• 1) полное наименование системы и ее условное обозначение;
• 2) шифр темы или шифр (номер) договора;
• 3) наименование компаний разработчика и заказчика (пользователя) системы и их реквизиты;
• 4) перечень документов, на основании которых создается система, кем и когда утверждены эти документы;
• 5) плановые сроки начала и окончания работы по созданию системы;
• 6) сведения об источниках и порядке финансирования работ;
• 7) порядок оформления и предъявления заказчику результатов работ по созданию системы (ее частей), по изготовлению и наладке отдельных средств (технических, программных, информационных) и программно-технических (программно-методических) комплексов системы.

2.4. Раздел «Назначение и цели создания (развития) системы» состоит из подразделов:

• 1) назначение системы;
• 2) цели создания системы.

2.4.1. В подразделе «Назначение системы» указывают вид деятельности системы (управление, проектирование и т. п.) и перечень объектов информатизации (объектов), на которых предполагается ее использовать.

2.4.2. В подразделе «Цели создания системы» приводят наименования и требуемые значения технических, технологических, производственно-экономических или других показателей объекта информатизации, которые должны быть достигнуты в результате создания ИС, и указывают критерии оценки достижения целей создания системы.

2.5. В разделе «Характеристики объекта информатизации» приводят:

• 1) краткие сведения об объекте информатизации или ссылки на документы, содержащие такую информацию;
• 2) сведения об условиях эксплуатации объекта автоматизации.

2.6. Раздел «Требования к системе» состоит из следующих подразделов:

• 1) требования к системе в целом;
• 2) требования к функциям (задачам), выполняемым системой;
• 3) требования к видам обеспечения.

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

2.6.1. В подразделе «Требования к системе в целом» указывают:

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

2.6.1.1. В требованиях к структуре и функционированию системы приводят:

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

2.6.1.2. В требованиях к численности и квалификации персонала на ИС приводят:

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

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

2.6.1.4. В требования к надежности включают:

• 1) состав и количественные значения показателей надежности для системы в целом или ее подсистем;
• 2) перечень аварийных ситуаций, по которым должны быть регламентированы требования к надежности, и значения соответствующих показателей;
• 3) требования к надежности технических средств и программного обеспечения;
• 4) требования к методам оценки и контроля показателей надежности на разных стадиях создания системы в соответствии с действующими нормативно-техническими документами.

2.6.1.5. В требования по безопасности включают требования по обеспечению безопасности при поставке, наладке, эксплуатации и обслуживании системы.

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

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

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

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

2.6.1.10. В дополнительные требования включают специальные требования по усмотрению разработчика или заказчика системы.

2.6.2. В подразделе «Требование к функциям (задачам)», выполняемым системой, приводят:

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

2.6.3. В подразделе «Требования к видам обеспечения» в зависимости от вида системы приводят требования к математическому, информационному, лингвистическому, программному, техническому, метрологическому, организационному, методическому и другие видам обеспечения системы.

2.6.3.2. Для информационного обеспечения системы приводят требования:

• 1) к составу, структуре и способам организации данных в системе;
• 2) к информационному обмену между компонентами системы;
• 3) к информационной совместимости со смежными системами;
• 4) по применению систем управления базами данных;
• 5) к структуре процесса сбора, обработки, передачи данных в системе и представлению данных;
• 6) к защите данных;
• 7) к контролю, хранению, обновлению и восстановлению данных;

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

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

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

2.6.3.5. Для технического обеспечения системы приводят требования:

• 1) к видам технических средств, в том числе к видам комплексов технических средств, программно-технических комплексов и других комплектующих изделий, допустимых к использованию в системе;
• 2) к функциональным, конструктивным и эксплуатационным характеристикам средств технического обеспечения системы.

2.6.3.6. В требованиях к метрологическому обеспечению приводят:

• 1) предварительный перечень измерительных каналов;
• 2) требования к точности измерений параметров и (или) к метрологическим характеристикам измерительных каналов;
• 3) требования к метрологической совместимости технических средств системы;
• 4) перечень управляющих и вычислительных каналов системы, для которых необходимо оценивать точностные характеристики;
• 5) требования к метрологическому обеспечению технических и программных средств, входящих в состав измерительных каналов системы, средств, встроенного контроля, метрологической пригодности измерительных каналов и средств измерений, используемых при наладке и испытаниях системы;
• 6) вид метрологической аттестации (государственная или ведомственная) с указанием порядка ее выполнения и организаций, проводящих аттестацию.

2.6.3.7. Для организационного обеспечения приводят требования:

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

· 2) к организации функционирования системы и порядку взаимодействия персонала ИС и персонала объекта информатизации;

· 3) к защите от ошибочных действий персонала системы.

2.7. Раздел «Состав и содержание работ по созданию (развитию) системы» должен содержать перечень стадий и этапов работ по созданию системы, сроки их выполнения, перечень организаций - исполнителей работ, ссылки на документы, подтверждающие согласие этих организаций на участие в создании системы, или запись, определяющую ответственного (заказчик или разработчик) за проведение этих работ.

В данном разделе также приводят:

• 1) перечень документов предъявляемых по окончании соответствующих стадий и этапов работ;
• 2) вид и порядок проведения экспертизы технической документации (стадия, этап, объем проверяемой документации, организация-эксперт);
• 3) программу работ, направленных на обеспечение требуемого уровня надежности разрабатываемой системы (при необходимости);
• 4) перечень работ по метрологическому обеспечению на всех стадиях создания системы с указанием их сроков выполнения и организаций-исполнителей (при необходимости).

2.8. В разделе «Порядок контроля и приемки системы» указывают:

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

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

В перечень основных мероприятий включают:

• 1) приведение поступающей в систему информации (в соответствии с требованиями к информационному и лингвистическому обеспечению);
• 2) создание условий функционирования проекта, при которых гарантируется соответствие создаваемой системы требованиям, содержащимся в ТЗ;
• 3) создание необходимых для функционирования системы подразделений и служб;
• 4) сроки и порядок комплектования штатов и обучения персонала.

2.10. В разделе «Требования к документированию» приводят:

• 1) согласованный разработчиком и Заказчиком системы перечень подлежащих разработке комплектов и видов документов;
  перечень документов, выпускаемых на машинных носителях;
• 2) при отсутствии государственных стандартов, определяющих требования к документированию элементов системы, дополнительно включают требования к составу и содержанию таких документов.

2.11. В разделе «Источники разработки» должны быть перечислены документы и информационные материалы, на основании которых разрабатывалось ТЗ и которые должны быть использованы при создании системы.

Сеть доступа

Сеть доступа представляет собой нижний уровень иерархии телекоммуникационной сети.

К этой сети подключаются конечные (терминальные) узлы - оборудование, установленное у пользователей (абонентов, клиентов) сети. В случае компьютерной сети конечными узлами являются компьютеры, телефонной - телефонные аппараты, а телевизионнойили радиосети - соответствующие теле- и радиоприемники.

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

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

Магистральная сеть

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

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

Информационные центры

Информационные центры /центры управления сервисами - это собственные информационные ресурсы сети, на основе которых осуществляется обслуживание пользователей. В таких центрах может храниться информация двух типов:

· пользовательская информация, то есть те данные, которые непосредственно интересуют пользователей сети;

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

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

К ресурсам второго типа относятся, например, различные системы аутентификации и авторизации пользователей, с помощью которых организация, владеющая сетью, проверяет права пользователей на получение тех или иных услуг; системы биллинга, которые в коммерческих сетях подсчитывают плату за предоставленные услуги; базы данных учетной информации пользователей, хранящие имена и пароли, а также перечни услуг, на которые подписан каждый пользователь. В телефонных сетях существуют центры управления сервисами (Services Control Point, SCP), где установлены компьютеры, на которых хранятся программы нестандартной обработки телефонных вызовов пользователей, например вызовов бесплатных справочных служб коммерческих предприятий (так называемые службы 800) или вызовов при проведении телеголосования. Еще одним из распространенных видов вспомогательного информационного центра является централизованная система управления сетью, которая представляет собой программное обеспечение, работающее на одном или нескольких компьютерах.

Биматричные игры.

ВОПРОСЫ К ГОСАМ

Техническая документация на информационную систему

Техническая документация на разработку информационной системы (ИС)

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

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

Аналитический отчет может быть выполнен согласно требованиям ГОСТ 7.32-2001. Данный вид технической документации может содержать описание бизнес-процессов предприятия, рекомендации по автоматизации отдельных процессов. На стадии обследования объекта автоматизации аналитиками обычно формируется словарь терминов, описывающий предметную область, а также процессы, протекающие на предприятии. Все эти данные должны быть зафиксированы в технической документации для дальнейшего согласования их заказчиком. Описание процессов может быть выполнено с помощью диаграммы IDEF0 или диаграммы вариантов использования UML. Диаграммы, размещенные в аналитическом отчете, следует сопровождать текстовым описанием, где необходимо указать:

краткое описание процесса;

действующие лица (актеры);

предусловие;

постусловие;

основной сценарий процесса;

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

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

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

В конце документа следует дать технико-экономическое обоснование разработки ИС. Данный раздел технической документации, при необходимости, может быть выделен в отдельный документ.

Этап обследования объекта автоматизации юридически может быть оформлен отдельным договором или включен в перечень работ по созданию ИС.

Следующим этапом создания ИС, является уточнение требований и на основании этого анализа создание документа «Техническое задание». На данном этапе производится детализация процессов, выявленных на этапе обследования, которая способствует формированию списка функциональных требований к Системе. Функциональные требования могут быть описаны в технической документации при помощи все тех же диаграмм UML: use case (варианты использования или диаграммы прецедентов), avtivity (сценарии вариантов использования), state machine (диаграмма конечных автоматов).

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

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

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

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

На этапе эскизного проекта формируются документы, предназначенные в основном для разработчиков Системы, поэтому формат и состав технической документации может отступать от требований ГОСТа. Например, в нашей компании для разработчиков аналитиками создаются отдельные технические спецификации, выполненные согласно стандарту IEEE 830-1998 «Recommended Practice for Software Requirements Specifications». Данный документ может содержать детальный сценарий поведения Системы при вызове определенной функции, а также прототипы экранных форм, на которых данная функция реализована. Данный документ не выходит за рамки проектной команды и необходим только для внутреннего использования. Для описания реакции Системы на определенные сигналы, сообщения или действия в спецификацию можно включить диаграмму взаимодействия. Для спецификации объектов баз данных разработчиками может быть создана диаграмма классов.

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

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

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

«Описание постановки задач» - данный документ целесообразен, если функциональные требования в Техническом задании были описаны не достаточно детально.

«Описание организации информационной базы» - данный документ обычно включает логическое описание базы данных (БД) Системы. Документ предназначен для разработчиков БД.

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

Перечень технической документации создаваемой для заказчика оформляется в документе «Ведомость технического проекта».

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