Разработка технической документации

 

Мы разрабатываем любые виды технической документации. Наши технические писатели осуществляют оформление технической документации как в соответствии с ГОСТ, так и по внутренним стандартам компании. Мы разрабатываем технический текст для ИТ сфер, в частности:

  • программное обеспечение;
  • автоматизированные системы;
  • интернет-проекты;
  • бизнес-процессы ИТ;
  • технические средства и устройства.

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

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

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

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

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

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

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

Ниже приведен список документов по ГОСТ, написанных нами:

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

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

С условиями и схемой работы вы можете ознакомиться в разделе «Условия сотрудничества».

________________________________________________________________________________________

 

ОСНОВНЫЕ ТЕРМИНЫ

 

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

Состав технической документации на автоматизированные системы можно определить, воспользовавшись стандартами ГОСТ 34.201-89 Информационная технология. Комплекс стандартов на автоматизированные системы.  «Виды, комплектность и обозначение документов при создании автоматизированных систем».

Данные стандарты объединяют в себе основной комплект документации, необходимой при разработке автоматизированной системы, а именно:

  • документация на автоматизированную систему: Комплект взаимосвязанных документов, полностью определяющих технические требования к АС, проектные и организационные решения по созданию и функционированию АС
  • приемочная документация на автоматизированную систему: Документация, фиксирующая сведения, подтверждающие готовность АС к приемке ее в эксплуатацию, соответствие АС требованиям нормативных документов
  • техническое задание на автоматизированную систему: Документ, оформленный в установленном порядке и определяющий цели создания АС, требования к АС и основные исходные данные, необходимые для ее разработки, а также план-график создания АС
  • технический проект автоматизированной системы: Комплект проектных документов на АС, разрабатываемый на стадии «Технический проект», утвержденный в установленном порядке, содержащий основные проектные решения по системе в целом, ее функциям и всем видам обеспечения АС и достаточный для разработки рабочей документации на АС
  • рабочая документация на автоматизированную систему: Комплект проектных документов на AC, разрабатываемый на стадии «Рабочая документация», содержащий взаимоувязанные решения по системе в целом, ее функциям, всем видам обеспечения АС, достаточные для комплектации, монтажа, наладки и функционирования АС, ее проверки и обеспечения работоспособности
  • эксплуатационная документация на автоматизированную систему: Часть рабочей документации на АС, предназначенная для использования при эксплуатации системы, определяющая правила действия персонала и пользователей системы при ее функционировании, проверке и обеспечении ее работоспособности
  • технорабочий проект автоматизированной системы: Комплект проектных документов АС, утвержденный в установленном порядке и содержащий решения в объеме технического проекта и рабочей документации на АС.

Состав технической документации описан в разделе ГОСТ 34.201-89  «1. Виды и наименования документов». (www.rugost.com)

 

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

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

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

Содержание программного документа

Спецификация

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

Ведомость держателей подлинников

Перечень предприятий, на которых хранят подлинники программных документов

Текст программы

Запись программы с необходимыми комментариями

Описание программы

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

Программа и методика испытаний

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

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

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

Пояснительная записка

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

Эксплуатационные документы

Сведения для обеспечения функционирования и эксплуатации программы

К эксплуатационным документам относятся:

Вид эксплуатационного документа

Содержание эксплуатационного документа

Ведомость эксплуатационных документов

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

Формуляр

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

Описание применения

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

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

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

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

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

Руководство оператора

Сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы

Описание языка

Описание синтаксиса и семантики языка

Руководство по техническому обслуживанию

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

(www.rugost.com)


Ведение технической документации

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

 

Техническое задание на автоматизированные системы. Разработка технического задания.

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

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

1)      общие сведения;

2)      назначение и цели создания (развития) системы;

3)      характеристика объектов автоматизации;

4)      требования к системе;

5)      состав и содержание работ по созданию системы;

6)      порядок контроля и приемки системы;

7)      требования к составу и содержанию работ по подготовке объекта автоматизации к вводу системы в действие;

8)      требования к документированию;

9)      источники разработки.

В ТЗ на АС могут включаться приложения. В зависимости от вида, назначения, специфических особенностей объекта автоматизации и условий функционирования системы допускается оформлять разделы ТЗ в виде приложений, вводить дополнительные, исключать или объединять подразделы ТЗ.В ТЗ на части системы не включают разделы, дублирующие содержание разделов ТЗ на АС в целом. (www.rugost.com)

 

Техничеcкое задание на разработку программы

При разработке технического задания на программу рекомендуем воспользоваться стандартом ГОСТ 19.201-78 «Техническое задание. Требования к содержанию и оформлению». Настоящий стандарт устанавливает порядок построения и оформления технического задания на разработку программы или программного изделия для вычислительных машин, комплексов и систем независимо от их назначения и области применения.

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

1)       введение;

2)       основания для разработки;

3)       назначение разработки;

4)       требования к программе или программному изделию;

5)       требования к программной документации;

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

7)       стадии и этапы разработки;

8)       порядок контроля и приемки;

9)       в техническое задание допускается включать приложения.

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

 

Сандарт ГОСТ

ГОСТ — слово английское и в переводе означает норма, образец. Образец в том смысле, какой мы вкладываем в понятие «такой же», «одинаковый».

Данную аббревиатуру условно можно разделить на 2 части: ГО - СТ, что означает ГОсударственный СТандарт. Это основная категория стандартов, регламентирующих качество и особенности производства самых различных товаров, от технического оборудования до хлебобулочных изделий. Какой состав разрешен для продуктов, ввозимых и производимых в стране, какая технология, методы производства других товаров, - это определяется ГОСТом.

Тогда что такое ГОСТ Р? Данные наименования носят стандарты, принятые в России. ГОСТ Р - единственная система сертификации в России, согласно которой существуют отработанные процедуры, методы сертификационной экспертизы. Данная экспертиза проводится группой организаций с соблюдением данных методов и процедур.

Мы посмотрели, что значит ГОСТ, теперь ответим, для чего он был разработан, с какой целью. До сентября 2011 года закон о техническом регулировании предусматривал неукоснительное соблюдение всех стандартов, имеющих целью защиту здоровья и жизни граждан, имущества (юридических, физических лиц, государственного и муниципального), охрану окружающей среды, здоровье и жизнь животных, растений.

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

Так, в России Вы можете встретить такие обозначения как ГОСТ Р, ГОСТ РФ или РСТ. Национальным органом по стандартизации будет Федеральное агентство по техническому регулированию и метрологии (Росстандарт).

Государственные стандарты (ГОСТ) впервые были разработаны Комитетом по стандартизации при Совете труда и обороны, созданном в 1925 году. Тогда 80 лет назад были разработаны и утверждены стандарты, регламентирующие производство практически всего - начиная от продуктов питания и заканчивая автомобилями. Данные стандарты носили обязательный характер и действовали на всей территории СССР.

На сегодняшний день насчитывается порядка 25 тысяч ГОСТов, которые распространены не только на территории Российской Федерации, но и некоторых стран СНГ, таких как Азербайджан, Армения, Белоруссия, Грузия, Казахстан, Киргизия, Молдова, Таджикистан, Узбекистан, Украина. С 27 декабря 2002 года, согласно Федеральному закону о техническом регулировании (№184-ФЗ) ГОСТ перестал носить обязательный характер и может применяться добровольно (за исключением случаев, касающихся обеспечения безопасности здоровья граждан или окружающей среды). В этом же году было введено понятие технического регламента, который в будущем должен заменить государственные стандарты.

Публикация текстов ГОСТов на территории Российской Федерации должна вестись на бесплатной основе. На официальном сайте Федерального агентства по техническому регулированию и метрологии можно найти в открытом доступе большинство государственных стандартов. 

 

Классификация ГОСТов

На сегодняшний день классификация ГОСТов ведется по Общероссийскому классификатору, разработанному в ВНИИ классификации, терминологии и информации по стандартизации и качеству и введенному в действие в 2000 году. Общероссийский классификатор согласуется с Международным классификатором стандартов ISO.

В данном классификаторе каждому стандарту присваивается соответствующий цифровой код, который состоит из номера и года утверждения ГОСТа. Номер стандарта имеет префикс, указывающий его на принадлежность к определенной серии документации, и порядковый номер, который определяется последовательностью принятия.

Например:

  • ГОСТ 19 .ххх – Единая Система программной документации (ЕСПД)
  • ГОСТ 2 .ххх – Единая Система конструкторской документации (ЕСКД

Наиболее частой проблемой при разработке технической документации является вопрос выбора правильного стандарта (ГОСТ 19 или ГОСТ 34). 

При разработке технической документации на автоматизированную систему необходимо руководствоваться рекомендациями стандартов входящих в состав ГОСТ 34.

При разработке технической документации на программы принято использовать ГОСТ 19. (elhow.ru,it-gost.ru)