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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Спецификация (ГОСТ 19.202-78)
 
Подскажите, чем отличается спецификация от Ведомости эксплуатационных док-тов?
Если есть примеры буду рад их посмотреть.
Заранее спасибо
С уважением, Максим!
 
Существует понятие основного программного документа их два вида: для комплексов - спецификация, для компонентов - текст программы (т.е. то, что написали программисты). Кстати определение комплекса и компонента см. ЕСПД. Фактически параллель идет из ЕСКД, где для детали (например для гайки) основной документ это чертеж, а для сборочной единицы (например для самолета) - спецификация. Спецификация определяет состав изделия (состав всей рабочей документации), а ведомость ЭД более узкий документ - он определяет лишь состав эксплуатационной документации на изделие, кот входит в состав рабочей документации.
 
Спасибо за ответы..
Простите за мою тупость, но хотел бы еще задать пару вопросов, касающихся спецификации, уже конкретика.
определились, что у мне нужно описать программный комплекс,  который состоит из двух частей. В спецификации мне нужно указать:
1. раздел документы
Описание программы
Описание применения
Пояснительная записка
ТУ
Формуляр
Руководство системного программиста (администратора)
Ведомость эксплуатационных документов

2. раздел Комплексы:
пишем полное наименование комплекса. а какие доки сюда включать? и нужно ли?

3. раздел Компоненты
серверная часть  - описать  ОС, описать СУБД,  описать WEB-сервер
клиентская часть - описать ОС клиента, описать клиентскую часть
здесь нужно приводить какие-нибудь документы?? ну скажем документы на установку ОС на сервере, установку СУБД и WEB сервера? У нас просто передача  продукта осуществляется уже на готовом настроенном сервере. (по словам рук. проекта)
С уважением, Максим!
 
Можно поступить следующим образом:
вы пишете спецификацию только на то, что разрабатываете (т.е. на то, что программируете), а остальное (ОС, СУБД и т.д.) называете общесистемным программным обеспечением, описываете (в смысле перечисляете) все это в поясн. записке (например), а в спецификацию эти вещи не включаете. Т.е. Вы поставляете свой продукт, а для его работы необходимо то-то и то-то. В эксплуатаицонной документации ссылаетесь на экпл-ю документацию общесистемного ПО. Такое решение обычная практика.
 
тогда получается следующее:
в разделе 1 Документы я разрабатываю  перечисленные выше документы для системы
в разделе 2 "Комплексы" я привожу наименование  системы которую разрабатываю.
раздел 3 получается тогда совсем не нужен? или  в него написать  модули комплекса, например,  
управление  пользователями
проверка подлинности пользователя при входе в систему
управление новостными статьями и тд. и т.п.
С уважением, Максим!
 
Второй раздел я бы тоже не заполнял - иначе получается что комплекс входит сам в себя.
 
В моем случае доки, которые я перечисляю в разделе 1 совпадают с доками  в Ведомости  эксплуатационной документации (за исключением  ТУ)
С уважением, Максим!
 
Вообще-то описание программы и пояснительная записка не являются эксплуатационными документами, поэтому их в ведомость ЭД вносить не стоит, если конечо нет какого-нибудь спец. замысла.
 
абсолютно с Вами согласен!! ГОСТ 19.101-77 п.2.3, табл.3
проглядел:(
С уважением, Максим!
 
Полезный форум, надеюсь еще живой)
Нужна помощь в составлении документации к ПО.
Документация (спецификация, ведомость держателей подлинников, текст программ и т.д.) составляется на разработанную или адаптированную программу. (ГОСТ 34.601-90, п.6.2).
И в титульном листе каждого документа указывается полное название программы. (ГОСТ 19.104-78)
Вопрос: как быть если программа не разрабатывалась и не адаптировалась (как я понял адаптация подразумевает изменение исходного кода)? В СА будет включена готовая программа, причем с ее помощью разрабатывается лишь конфигурация для оборудования (как я понимаю это не то же, что и адаптация http://www.osp.ru/os/2008/06/5343884/). Эта конфигурация не является отдельной программой со своим названием, чтобы для него писать спецификацию. Но в ТЗ заказчик в перечне указал список поставляемой документации, куда все выше перечисленное занесено.
Помогите разобраться в ситуации.
Благодарю.
С уважением, Айрат.
Страницы: 1
Читают тему