Разработка технической документации и технические писатели Технические писатели и разработка технической документации технические писатели в Телеграм 

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Стандартный набор ГОСТов для описания программы, программного обеспечения (ПО), Какие ГОСТы нужно использовать для описании программы и какой пакет документации необходим на ПО
 
Исходя из сложившейся ситуации , многие ГОСТы устарели, скажите наиболее нужные для описания программы, действительно нужные, а не номенклатурные, не хочется разводить кипу не нужных(устаревших) документов. Сейчас я вижу востребованность только в четырех ГОСТах для написания следующих документов это:
  1. Техническое задание - ГОСТ 19.201-78 Техническое задание, требования к содержанию и оформлению)
  2. Описание программы - ГОСТ 19.402-78 Описание программы
  3. Руководство оператора ГОСТ 19.505-79 Руководство оператора. Требования к содержанию и оформлению )
  4. Руководство системного программиста ГОСТ 19.503-79 Руководство системного программиста. Требования к содержанию и оформлению)
Сейчас у меня на работе, начальство, решило перейти на ГОСТы, зачем? для меня это великая тайна  :(  ...и простые вещи начинают приобретать какой-то абсолютно непонятный смысл.
Один из вопросов, чем отличаются госты  ГОСТ 19.503-79  (Руководство системного программиста) и ГОСТ 19.504-79 Руководство программиста. Требования к содержанию и оформлению . Чем эти программисты отличаются.
Подводя итог: Кто может сказать стандартый набор ГОСТов для описания программы, без лишней воды. Спасибо
пойдем со мной?
 
Мы обычно используем следующий пакет документов:
-Техническое задание
-Общее описание системы или Пояснительная записка (в зависимости от требования заказчика)
-Описание организации информационной базы
-Руководство пользователя
-Руководство администратора
-Программа и методика испытаний
Для создания данной документации используется в основном РД 50-34.698-90 ( http://it-gost.ru/content/view/15/41/).
 
Необходимо учитывать стадии разработки, соотвественно отделять предпроектные, проектные документы, документы стадии рабочей документации. Вероятно у Вас имеет сделать следующее:
1) На стадии тех. задания - ТЗ;
2) На стадии эскизного или тех. проекта-пояснительная записка;
3) на стадии рабочей документации:
    а) спецификация;
    б) описание программы;
    в) программа и методика испытаний;
    г) ведомость эксплуатационных документов;
    д) непосредственно сами экспл-е документы. А вот тут несложная хитрость - чтобы не писать руководства программиста и руководства системного программиста для программ где вообще при эксплуатации программист не подразумевается (что вообще-то в условиях нашей жизни является реальностью (если Вы не купили машину времени и не откатились в 197.. :))), включаете в комплект эксплуатационных документов те документы кот. считаете нужными, т.е. руководство по установке, руководство администратора и т.д., а коды берете из диапазона 90-99 (документы прочие) - тут до Вас никто не докопается.
   е) возможно в связи с различными сертификациями придется еще что-либо включить (если не знаете про сертификации, то спите пока спокойно :), про это я отдельно напишу, м.б. наваяю статейку и выложу на сайте либо ту т либо у себя).
Вот пожалуй и все. А еще момент- предыдущий оратор указывал на документ РД..., так вот он относится к автоматизированным системам, а то о чем писал я - к программному обеспечению (ПО это не АС, см. определения для АС).
 
Цитата
Необходимо учитывать стадии разработки, соотвественно отделять предпроектные, проектные документы, документы стадии рабочей документации.
Вот это прямо в памятку техническому писателю можно занести
Работаю по-старинке...
 
Вот здесь лежат шаблоны документов по ГОСТ
Страницы: 1
Читают тему