Выбор (уточнение) состава комплекта документов
Выбор (уточнение) состава комплекта документов определяется предметом разработки (и документирования), а также целями и задачами документирования (видом разработки). Редакция от 12.03.2021.
Разработка технической документации на заказ
Пора сдавать работу, а техдокументации как не было, так и нет? «Шеф, все пропало! Гипс снимают, клиент уезжает!».
А так здорово все начиналось! С блеском победили в конкурсе, за полгода провели полное обследование объектов заказчика, совещались, уточняли мельчайшие детали по функциональным задачам, подписывали протоколы, даже получили положительное заключение по пояснительной записке к техническому проекту, но потом настал этап РКД, а вслед за ним и...
Так? Типичнейшая ситуация. Главное - не впадать в отчаяние. Поможем за считанные дни выполнить то, что должно было быть сделано еще полгода назад... Редакция от 08.11.2020.
Изучение объекта (предмета) документирования
Тщательное изучение объекта документирования позволяет выбрать наиболее подходящую систему или комплекс стандартов для подготовки комплекта документов, что существенно сокращает как время разработки, так и ее стоимость. Редакция от 12.03.2021.
Комплект программных документов по ГОСТ 19.101-77
Дражайшим соотечественникам отныне доступен комплект программных документов по ГОСТ 19.101-77, выполненный с учетом требований ЕСПД, но видео «лучше всяких слов порою...»
Основой комплекта послужила авторская библиотека взаимоувязанных документов, разработанная с применением программы AuthorIT и «портированная» в Drupal. Портированная библиотека как распределенная информационная система обеспечивает возможность создания СОБСТВЕННЫХ КОМПЛЕКТОВ ПРОГРАММНЫХ ДОКУМЕНТОВ путем взаимодействия пользователей в составе приватных ГРУПП (как в одноклассниках).
Разработка комплектов программной документации на основе библиотеки организована по известному принципу - «чтоб это сделалось как-нибудь так, незаметно, само собой...». Иными словами, при работе каждого пользователя над ЛЮБЫМ документом комплекта содержимое всех прочих документов заполняется или изменяется автоматически и с сохранением семантического форматирования текста. Обеспечивается также мгновенный просмотр изменений во всех связанных документах в любой момент времени.
Следует отметить, что авторский подход к документированию не потребует от пользователя ни малейшего умственного напряжения, исключая тем самым усталость и пресыщение 🤪
Состав комплекта документов приведен в Спецификации, но для большей осмысленности восприятия принципа работы библиотеки для начала рекомендуется посетить песочницу. Редакция от 10.05.2021.
Обратная разработка техдокументации (реверс-инжиниринг)
Затерялась вся техдокументация на изделие, программу или автоматизированную систему, а надо срочно ее восстановить? Необходимо разработать что-то новое на основе прототипа? Обращайтесь, обратную разработку техдокуметации (реверс-инжиниринг) еще никто не отменял. Редакция от 12.03.2021.
Определение целей и задач документирования
Цели и задачи документирования определяются видом разработки, а видов, согласно Р 50-605-80-93, всего три: инициативная разработка, разработка в интересах заказчика и разработка в интересах конечного пользователя. Каждому виду разработки (и документирования) присущи свои собственные цели и задачи. Редакция от 12.03.2021.
Разработка техдокументации, внесение изменений, согласование и передача ее заказчику
Процесс разработки техдокументации у нас практически полностью автоматизирован, что стало возможным благодаря созданию и многократному повторному использованию элементов данных (тем), составляющих библиотеки взаимоувязанных документов. В качестве текстового процессора примененяется инструментарий разработки на основе single source. Редакция от 12.03.2021.
Разработка технической документации на заказ
Пора сдавать работу, а техдокументации как не было, так и нет? «Шеф, все пропало! Гипс снимают, клиент уезжает!».
А так здорово все начиналось! С блеском победили в конкурсе, за полгода провели полное обследование объектов заказчика, совещались, уточняли мельчайшие детали по функциональным задачам, подписывали протоколы, даже получили положительное заключение по пояснительной записке к техническому проекту, но потом настал этап РКД, а вслед за ним и...
Так? Типичнейшая ситуация. Главное - не впадать в отчаяние. Поможем за считанные дни выполнить то, что должно было быть сделано еще полгода назад... Редакция от 12.03.2021.
Сбор информации, консультации и поиск нормативных документов по предметной области
Сбор информации, консультации и поиск нормативных документов по предметной области - важнейший и интереснейший этап разработки техдокументации, схожий с процессом создания АС. Этап завершает «формирование исходных требований» подобно стадии «Формирование исходных требований к АС» (Формирование требований пользователя к АС). Редакция от 12.03.2021.
Уточнение требований к оформлению комплекта документов
Уточнение требований к оформлению комплекта документов заключается в выборе шаблона оформления, формата и носителя технической документации. Правила оформления техдокументации регламентируются ГОСТ 2.004, ГОСТ 2.104-2.106, ГОСТ 19.106, ГОСТ 34.602 и рядом других нормативных документов. Редакция от 12.03.2021.
Copyright © «Техническая документация» 2008-2021. Заимствуйте наши материалы с блеском! При воспроизведении материалов портала обязательна установка активной гиперссылки на источник — страницу с этой публикацией на tdocs.su.
