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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Пояснительная записка
 
В связи с переходом на ГОСТы, мне нужно соответственно переработать документацию. У нас было два документа Функциональное и техническое описание программы, согласно ГОстам куда их определить?
пойдем со мной?
 
На мой взгляд, больше всего подходит «Пояснительная записка» (ГОСТ 19.404-79  или РД 50-34.698-90 ). Шаблон пояснительной записки можно скачать здесь http://it-gost.ru/content/view/89/52/.
 
Если проектная стадия, то пояснительная записка. Если стадия рабочей документации, то "Описание программы" ГОСТ 19.402. В части эксплуатационнной документации подобные сведения приводят в д-те "Описание применения" ГОСТ 19.502.
 
Цитата
Denis пишет:
Основной документ - это пояснительная записка. Тематика - мультисервисная телекоммуникационная система.
Документ "Пояснительная записка" имеет "говорящее" название: в документе необходимо пояснить предлагаемые решения по разработке Вашей системы. Согласно РД 50-34.698-902.2, документ должен состоять из разделов:
1) общие положения;
2) описание процесса деятельности;
3) основные технические решения;
4) мероприятия по подготовке объекта автоматизации к вводу системы в действие.
Думаю, понятно, что должно быть разделах "Общие положения", "Описание процесса деятельности" и "Мероприятия по подготовке объекта автоматизации к вводу в действие"? Если нет, то давайте распишу.
Обычно проблемы бывают с разделом "Основные технические решения". Часто бывает так, что раздел содержит описание, идентичное ТЗ. На самом деле, должно содержать детализированное описание конкретных решений с обоснованием их выбора.
Если на пальцах, то описание должно строиться по принципу: описание решения - ответ на вопрос: почему выбрано именно это решение?
Например, в разделе "Решения по структуре системы, подсистем, средствам и способам связи для информационного обмена между компонентами системы, подсистем" Вы должны написать, что система имеет такую-то структуру, состоит из таких-то компонент, связь между ними осуществляется так-то, а дальше должно следовать примерно такое изложение "Описанная структура выбрана потому-то или обеспечивает то-то... При выборе такой структуры решается такая-то задача, достигается такая-то цель...".
Не знаю, насколько понятно написала :)))
techwriter.ru.com
 
Здравствуйте!
Пишу пояснительную записку к техническому проекту на создание аппаратно-программного комплекса (АПК). Возникает резонный вопрос, на какой стандарт необходимо ориентироваться при составлении данного документа: ГОСТ 19.404-79 или РД 50.34?
==
Меньше *овна - больше доброты
 
Решил опираться на ГОСТ 2.106-96. Думаю, это не будет ошибкой.
==
Меньше *овна - больше доброты
 
Пояснительная записка
 
Обсуждаем составление документа "Пояснительная записка"
 
В  перечне видов документов, приведенных в стандартах ISO по жизненному циклу информационных систем, вид документа "Пояснительная записка" отсутствует.  Какой-то иной документ, состоящий из разделов, указанных в п. 2.2. РД 50-34.698-90 - тоже отсутствует. Как и большинство других документов, выдуманных советскими бюрократами в 70-е годы и перечисленных в ГОСТ 34-201-89.

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

Вместе с тем, на практике часто составляется краткое описание проекта, в котором содержатся, в том числе, краткие пояснения и обоснования. Такое описание используется для быстрого ознакомления с проектом, презентации проекта и т. п.
 
Цитата
perepelini написал:
Решил опираться на ГОСТ 2.106-96. Думаю, это не будет ошибкой.
Если выбрали тернистый путь, то обратите внимание, что для пояснительной записки по ГОСТ 2.106-96 в качестве 2.104 используется 2.104-2006, на него же ссылается 2.051-2006 Электронные документы.
 
Составлена ПЗ к эскизному проекту. Все предложения составили в будущем времени вида: "изделие будет выполнено в блочно-модульном исполнении". Заказчик пишет: "Будущее время в ПЗ не допустимо, получилось некая версия ТТ в будущем времени". Внимание вопрос! В каком времени составляется ПЗ? В настоящем или в будущем? в ГОСТах про это ничего нет.
 
Цитата
ПДП написал:
Составлена ПЗ к эскизному проекту. Все предложения составили в будущем времени вида: "изделие будет выполнено в блочно-модульном исполнении". Заказчик пишет: "Будущее время в ПЗ не допустимо, получилось некая версия ТТ в будущем времени". Внимание вопрос! В каком времени составляется ПЗ? В настоящем или в будущем? в ГОСТах про это ничего нет.
Лучше всего использовать глаголы настоящего время совершенного вида. "Будет выполнено" - очень неудачное словосочетание, обезличенное. Было бы терпимо "изделие должно быть выполнено". Но для эскизного проекта всё-таки лучше просто написать: "изделие выполнено...".
Страницы: 1
Читают тему