Библиотеки взаимоувязанных документов для AuthorIT

Библиотеки взаимоувязанных документов для AuthorIT будут полезны, в первую очередь, нашим коллегам, «конкурентам», да и просто заинтересованным лицам, пользующимся программой AuthorIT для разработки технической документации (кто в теме - тот поймет, остальным дальше читать не следует). Достоинства самой программы перечислять не имеет особого смысла, поскольку все детально расписано на сайте http://authorit.ru, а вот библиотеками, разработанными согласно требованиям ГОСТов, мы готовы поделиться (на определенных условиях) - Ржунимагу! (смайл) Редакция от 20.06.2018.

Библиотеки взаимоувязанных документов для AuthorIT

Создан 01.03.2018 11:06:45

- Библиотеки взаимоувязанных документов для AuthorIT

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

  1. библиотеками взаимоувязанных документов, разработанными согласно ЕСКД, в частности, по ГОСТ 2.601, ГОСТ 2.610, включая ссылочные стандарты. Модификаций множество - от совсем простых изделий (вроде лома или лопаты) до систем пожаротушения и интегрированных систем безопасности;
  2. библиотеками взаимоувязанных документов, разработанными согласно 34 комплексу стандартов. Модификации - системы коммерческого учета электроэнергии, всевозможные медицинские системы, Интернет-порталы различного профиля (вплоть до федерального уровня) и пр.;
  3. библиотеками взаимоувязанных документов, разработанными согласно ЕСПД.

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

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

Виды программных документов и их содержание по ГОСТ 19.101-77

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

[из п. 2.2 ГОСТ 19.101-77]

Виды эксплуатационных документов по ГОСТ 19.101-77

Виды эксплуатационных документов и их содержание приведены таблице.

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

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

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

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

Формуляр

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

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

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

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

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

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

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

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

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

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

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

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

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

[из п. 2.3 ГОСТ 19.101-77]

Некоторые уточнения:

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

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

Если заинтересовались - звоните или пишите в контакты.

- Контакты ООО «Техническая документация»

Заказать услуги ООО «Техническая документация» можно по эл. почте admin @ tdocs . su (без пробелов), тел. 8-910-468-09-28 или в форме Контакты.

Copyright © ООО «Техническая документация» 2018. Заимствуйте наши материалы с блеском! При воспроизведении материалов портала обязательна установка активной гиперссылки на источник — страницу с этой публикацией на tdocs.su.

Яндекс.Метрика