Мы разрабатываем любые виды проектной документации для IT. Наши технические писатели осуществляют оформление технической документации как в соответствии с ГОСТ 34, ГОСТ 19, ГОСТ 2 так и по внутренним стандартам компании. Мы разрабатываем техническую документацию, в том числе, на следующие виды программных продуктов:
Автоматизированные системы
Программное обеспечение
Веб-порталы
Мобильные приложения
Интернет-проекты
Веб-приложения
Создание любой автоматизированной системы, а также ее эксплуатация в обязательном порядке требует наличия технической документации. Написание и последующее ведение проектной документации осуществляется аналитиками и техническими писателями на всех этапах, начиная от разработки технического задания программистам и заканчивая разработкой текста для справочной системы и руководством (инструкцией) для конечных пользователей.
Специалисты по технической документации нашего агентства — аналитики и технические писатели знают принципы построения ИТ-систем и имеют опыт общения с заказчиками разных сфер деятельности, поэтому мы сможем предоставить услуги по разработке и оформлению проектной документации понятной как заказчику, так и разработчику.
Так же мы проведем аудит уже написанных вами документов на соответствие нормам и правилам написания технических документов и, если необходимо, ГОСТ.
Мы можем изучить любую автоматизированную систему изнутри для подготовки технической документации и текста для справочной системы.
Так же мы осуществляем написание и аудит документов по ГОСТ Р 15.301-2016 и ГОСТ 7.32-2017.
С нашей помощью процесс подготовки и оформления проектной документации будет происходить параллельно основной деятельности вашей компании. Кроме написания текста и оформления по стандартам ГОСТ или стандартам вашей компании, мы также можем также взять на себя аналитическую работы. В случае если вам необходимо перевести всю техническую документацию на английский или другой язык, наше агентство также осуществляет технический перевод документации на иностранный язык и адаптацию технической документации на иностранном языке к использованию в России.
Мы предлагаем услугу по разработке проектной документации и предоставляем следующих специалистов на проект:
- Технический писатель
- Бизнес-аналитик
- Системный аналитик
- Переводчик технической документации
Ниже приведен список документов по ГОСТ, написанных нами:
- Техническое задание;
- Частное техническое задание;
- Пояснительная записка к проекту;
- Общее описание системы;
- Описание автоматизируемых функций;
- Описание программного обеспечения;
- Описание информационного обеспечения;
- Описание комплекса технических средств;
- Программа и методика предварительных испытаний;
- Программа и методика приемочных испытаний;
- Руководство пользователя;
- Руководство администратора;
- Технологическая инструкция;
- Регламент обслуживания системы;
- Программа опытной эксплуатации;
- Отчет о результатах опытной эксплуатации;
- Ведомость покупных изделий;
- Ведомость машинных носителей информации и другие документы.
- Модель угроз
В последнее время, в рамках анализа безопасности автоматизированных систем, к нам часто обращаются с просьбой разработать документ «Модель угроз». Модель угроз содержит единые исходные данные по угрозам безопасности персональных данных, обрабатываемых в информационных системах персональных данных. У нас есть опыт разработки частных моделей угроз.
Позвоните нам +7 (499) 394 39 62 или напишите письмо post@difrows.ru: мы обязательно ответим на все интересующие вопросы, предложим варианты решения и рассчитаем стоимость работы.
Техническая документация на автоматизированные системы
Состав технической документации на автоматизированные системы можно определить, воспользовавшись стандартами ГОСТ 34.201-89 Информационная технология. Комплекс стандартов на автоматизированные системы. «Виды, комплектность и обозначение документов при создании автоматизированных систем».
Данные стандарты объединяют в себе основной комплект документации, необходимой при разработке автоматизированной системы, а именно:
- документация на автоматизированную систему: Комплект взаимосвязанных документов, полностью определяющих технические требования к АС, проектные и организационные решения по созданию и функционированию АС
- приемочная документация на автоматизированную систему: Документация, фиксирующая сведения, подтверждающие готовность АС к приемке ее в эксплуатацию, соответствие АС требованиям нормативных документов
- техническое задание на автоматизированную систему: Документ, оформленный в установленном порядке и определяющий цели создания АС, требования к АС и основные исходные данные, необходимые для ее разработки, а также план-график создания АС
- технический проект автоматизированной системы: Комплект проектных документов на АС, разрабатываемый на стадии «Технический проект», утвержденный в установленном порядке, содержащий основные проектные решения по системе в целом, ее функциям и всем видам обеспечения АС и достаточный для разработки рабочей документации на АС
- рабочая документация на автоматизированную систему: Комплект проектных документов на AC, разрабатываемый на стадии «Рабочая документация», содержащий взаимоувязанные решения по системе в целом, ее функциям, всем видам обеспечения АС, достаточные для комплектации, монтажа, наладки и функционирования АС, ее проверки и обеспечения работоспособности
- эксплуатационная документация на автоматизированную систему: Часть рабочей документации на АС, предназначенная для использования при эксплуатации системы, определяющая правила действия персонала и пользователей системы при ее функционировании, проверке и обеспечении ее работоспособности
- технорабочий проект автоматизированной системы: Комплект проектных документов АС, утвержденный в установленном порядке и содержащий решения в объеме технического проекта и рабочей документации на АС.
Состав технической документации описан в разделе ГОСТ 34.201-89 «1. Виды и наименования документов».
Техническая документация на программы
При составлении технической документации на программы следует опираться на требования Единой системы программной документации (ЕСПД) — ГОСТ 19.ххх. Исходя из данных требований, основными документами при разработки программ являются документы, содержащие сведения, необходимые для разработки, изготовления, сопровождения и эксплуатации программ:
Вид программного документа |
Содержание программного документа |
Спецификация | Состав программы и документации на нее |
Ведомость держателей подлинников | Перечень предприятий, на которых хранят подлинники программных документов |
Текст программы | Запись программы с необходимыми комментариями |
Описание программы | Сведения о логической структуре и функционировании программы |
Программа и методика испытаний | Требования, подлежащие проверке при испытании программы, а также порядок и методы их контроля |
Техническое задание | Назначение и область применения программы, технические, технико-экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний |
Пояснительная записка | Схема алгоритма, общее описание алгоритма и (или) функционирования программы, а также обоснование принятых технических и технико-экономических решений |
Эксплуатационные документы | Сведения для обеспечения функционирования и эксплуатации программы |
К эксплуатационным документам относятся:
Вид эксплуатационного документа |
Содержание эксплуатационного документа |
Ведомость эксплуатационных документов | Перечень эксплуатационных документов на программу |
Формуляр | Основные характеристики программы, комплектность и сведения об эксплуатации программы |
Описание применения | Сведения о назначении программы, области применения, применяемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств |
Руководство системного программиста | Сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения |
Руководство программиста | Сведения для эксплуатации программы |
Руководство оператора | Сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы |
Описание языка | Описание синтаксиса и семантики языка |
Руководство по техническому обслуживанию | Сведения для применения тестовых и диагностических программ при обслуживании технических средств |