Единые требования к оформлению технической документации

Да никуда не идет, на месте топчется - мне ли тебе рассказывать Топтаться на месте неохота - поэтому и не пытаюсь пока никуда устроиться. Надо чего-то самому организовывать. Голову уже на этом сломал

Народ - копошится. Процесс - идет
Хотелось бы еще понять - куда он идет, и по дороге ли нам с ним...

Отцам-командирам, сам знаешь - наплевать. Главное, чтобы народ копошился - процесс шел

Помнится мне, что попытку внедрения авторита на прежнем месте мы предпринимали совместно и безуспешно. Оно ж денег стоит...
А здесь - мне и показать нечего, и загонять всю эту тьму в авторит - как представлю - не по себе становится.
В принципе-то ты прав, конечно.

А все дело в нежелании осваивать AuthorIT У меня подобные проблемы давным-давно отпали

Отношения давние (задолго до моего прихода сложившиеся), и не вполне формальные.
Оно не то чтоб "ой" - но не приятно.
Я, в принципе, готов играть по любым правилам - но хорошо б по заранее заданным

Беда в том, что документации здесь (я, кажется уже писал) - больше 10000 страниц. И любая ерундовая правка выливается в черт-те-что...

Алексей, я так понял, что у Вас есть документ (комплект), который необходимо сдать заказчику, а он высказывает свои замечания только вслух?
Все, конечно, зависит от степени формализации отношений между разработчиком и заказчиком. Один из формальных подходов. Передаете заказчику документацию с сопроводительным письмом, в котором указываете, что в соответствии с тем-то и тем-то передается для рассмотрения (утверждения, согласования итд) документация (см. приложение 1). Прошу (настаиваю итп) Ваши замечания (предложения ...) изложить по форме приведенной в приложении 2 к такому-то сроку.

Ну, а если уже неформальные отношения, тады ой.

Тогда надо запускать рыночный механизм - деваться некуда. Либо откат, либо брать на субподряд - скрытый откат

Нет, вкусы не прописаны
Есть жесткое письмо с приложенными образцами документов, вполне приемлемыми. Но новый приемщик имеет "вкус", а кроме того - полномочия не принять документы, которые ему не нравятся. Вот и не принимает.
С формальной точки зрения я и в самом деле чист, но по факту придется соответствовать. Или - менять всё-всё. Чего мне бы не хотелось, поскольку получилось бы слишком часто. Не к лицу...
А письменные требования - прошу, но боюсь, что их не будет. Письменные - это ж ответственность, какая-никакая. Оно им надо?

А вкусы заказчика прописаны в ТЗ? Если нет, то с формальной точки зрения Вы чисты. А с неформальной можно заказать дизайнерскую проработку согласно письменным требованиям заказчика и за его счет, разумеется.

К сожалению, ситуация и проще, и неприятнее - речь идет не о том, что документы не соответствуют стандартам, а о том, что они не соответствуют вкусам заказчика (хотя соответствуют образцам, разработанным тем же заказчиком и более или менее соблюдающим требования ГОСТ).
А вкуса там - не бог весть сколько.
Что до утирания - то у меня есть основания предположить, что за ним последует необходимость срочно искать новую работу.
А я не люблю срочно. Я люблю постепенно.

Всё не так просто. Есть также ГОСТ 2.004-88 ЕСКД. Общие требования к выполнению конструкторских и технологических документов на печатающих и графических устройствах вывода ЭВМ и ГОСТ 19.106-78 ЕСПД. Требования к программным документам, выполненным печатным способом, которые допускают использование машинных шрифтов.

Тезка, утри нос заказчику - есть ГОСТ 2.304-81 ЕСКД Шрифты чертежные

Вряд ли удастся соблюсти во всем. Есть прямые (мелкие) противоречия; я, кажется, недавно про них вспоминал здесь где-то. Типа точек после номеров разделов, нумерации приложений и т.п.
Поэтому упирать (еще раз оговорюсь - по мелочам) на то, что "так - в ГОСТе", на мой взгляд, не следует. Если нарветесь на знатоков-буквоедов (их мало, но есть), то рискуете в любом раскладе остаться неправым.
А вообще-то Вы идете правильным путем, пытаясь собрать все требования в кучку. Я тоже на нем - но стою (времени нет совсем).

Т.е. это для размещения подписей - "и/или". А в целом Титульный лист - нужен по-любому, ЛУ - при необходимости (например, если подписей много и они не влезают на титульный. Могут быть даже многостраничными.
Из Вашего текста это не следует.

Про 3 - я и оговорился, что "вкусовщина". Мне всегда хочется уменьшить объем. В пределах разумного, конешно.

Алексей, о необходимости этих листов я не спорю. Конечно, ведь АС создается по заказу (как правило). Поэтому утверждающие и согласующие подписи необходимы. А вот размещаться они должны на ТЛ и/или на ЛУ (а, ведь между ними все-таки есть разница). Поэтому мы с вами в принципе говорим об одном и том же и разногласий нет. Это я не верно выразился.
Про абзацный отступ я хочу сказать, что если делать документацию по ГОСТам, то лучше соблюдать их и в этом. По крайней мере, противоречия не будет. Это я как юрист говорю.

Т.е. это для размещения подписей - "и/или". А в целом Титульный лист - нужен по-любому, ЛУ - при необходимости (например, если подписей много и они не влезают на титульный. Могут быть даже многостраничными.
Из Вашего текста это не следует.

Про 3 - я и оговорился, что "вкусовщина". Мне всегда хочется уменьшить объем. В пределах разумного, конешно.

Алексей, я эту фразу взял из ГОСТа 2.105 пункт 3.8.
С остальными дополнениями кроме 3, согласен.

На сайт http://www.wordexpert.ru - посмотрел, идея в принципе мне нравится, хотя микрософт и сам играет в эти игры (и, может быть, имеет смысл с ним повзаимодействовать).
Кажется, знаю ответы на некоторые вопросы - как удастся вздохнуть, пойду регистрироваться и отвечать.
Но знаю, что знаю не всё - нарвался тут на таблицы, поведение которых вызывает у меня изумление - при попытке что-то в них поменять они молча разъезжаются (примерно на формат А3, расположенный горизонтально). И загнать их назад не удается - приходится заводить новую таблицу и постепенно перетаскивать в нее содержимое старой. Когда таблица - страниц на 80 - это здОрово. Воспитывает...

Все не помню, но:
1. Титульный лист не эквивалентен ЛУ. Он - должен быть всегда, ЛУ может быть не везде. Поэтому "и/или" - это не так.
(ГОСТ 2.105-95. Общие требования к текстовым документам. (п.6.3): "ЛУ выпускают на один документ, на несколько документов, на альбом документов или комплект документов. Допускается выпускать ЛУ на отдельную часть или несколько частей документа".)
2. Нумеруют, начиная с номера 2 - титульный лист входит в общую нумерацию листов, но номера на нем самом нет.
3. "Вкусовщина" - отступ 1,5-1,7 - мне кажется великоват. Если абзацы невелики, они начинают выглядеть несколько "раздёрганно".
И межстрочные я обычно делаю поменьше - на больших доках это позволяет сэкономить объемы.

Вадим, спасибо за ваш отзыв.
Что касается буквы "Ш" и "И", то проблема в моем хостере, который перенес сайт на новый сервер и вот уже неделю не может (не хочет?) исправить ситуацию. Жалуюсь каждый день. Пока нет результата.

Автор последнего поста г-н akokin поскромничал упомянуть о том, что является автором сайта http://www.wordexpert.ru (те, кто недолюбливает Ворд, могут дальше не читать).
Я не поленился на него сходить и посмотреть. На сайте размещен ряд полезных вещей, но до совершенства ему еще далеко. Оформление приятное, но раздражает неадекватное отображение буквы «ш». Жаль, что нет форума.
Любителей Ворда призываю помочь в развитии этого сайта, автору рекомендую дружить с сайтом http://www.d0c.ru .

Коллеги, я начинаю работать техписом. Но за полтора месяца уже изучил необходимые мне ГОСТы. В основном, это касается АС. Для себя составил памятку с требованиями в части оформления. Привожу здесь, может кому поможет.
Если есть возражения или дополнения, буду рад услышать.
========================================

Стандартные требования по оформлению текстовых документов для АСУ
При создании АС разрабатываются различные документы, предусмотренные ГОСТ 34.201-89 на разных стадиях разработки. Но конкретный перечень документов устанавливается в Техническом задании. Этот перечень может быть расширен и дополнен документами, которые прямо не предусмотрены для АС. Например, для АС можно разрабатывать документы, предусмотренные ГОСТом 19.101. Соответственно, и оформлять эти документы, руководствуясь требованиями ГОСТ серии 19 и серии 2.

Единого документа, содержащего требования к оформленю документов, нет. Поэтому приходится дергать разные требования из разных документов и приспосабливать для себя. В общем случае можно применять положения ГОСТ 19.106-78.

1 Техническое задание
При разработке ТЗ непосредственно используются следующие ГОСТы:
ГОСТ 34.602-89, ГОСТ 34.201-89 (раздел 3 в части обозначения), ГОСТ 2.105 и ГОСТ 2.004-88 (в части внешнего оформления).
Поскольку ГОСТ 2.004-88 не содержит конкретных указаний в части шрифтового оформления, абзацных отступов и др., но допускает часть информации (текст) выполнять машинописным способом, то вполне логично применять к внешнему оформлению ТЗ требования ГОСТ 2.105. Более того, об этом прямо говорится в п.3.2 ГОСТ 34.602. Кстати, текст, выполненный на печатной машинке (машинописный текст), внешне похож на текст, печатаемый любым компьютером и потом выводимый на принтер.
Абзацы: 15-17 мм (п.3.6 ГОСТ 2.105).
Должен быть Титульный лист и (или) Лист утверждения (п.3.4 ГОСТ 34.602, раздел 6 ГОСТ 2.105).
Нумерация страниц: нумеруют, начиная с первого листа после ТЛ в верхней части листа (над текстом, посредине) после обозначения кода ТЗ на АС.
Нумерация разделов и подразделов (п.4.1.2 ГОСТ 2.105):
Разделы нумеруются арабскими цифрами без точки и записанные с абзацевого отступа. Каждый раздел начинается с нового листа (страницы).
Подразделы должны иметь нумерацию в пределах каждого раздела. Номер подраздела состоит из номеров раздела и подраздела, разделенных точкой. В конце номера подраздела точка не ставится. Разделы, как и подразделы, могут состоять из одного или нескольких пунктов.
Перечисления внутри разделов в соответствии с п.4.1.7 ГОСТ 2.105.
Заголовки: начиная с прописной буквы без точки в конце.
Интервалы: между заголовком и текстом – 3,4 интервала; между заголовком раздела и подразделом – 2 интервала. Интервалы между строк текста не определены этими ГОСТами. Поэтому допустимо применять положения ГОСТ 19.106-78 (п.1.2) – полуторный или двойной.
Содержание документа оформляют в соответствии с п.4.1.11 ГОСТ 2.105.
Оформление иллюстраций и приложений в соответствии с п.4.3 ГОСТ 2.105.
Таблицы оформляются в соответствии с п.4.4 ГОСТ 2.105.
Размеры полей документа: поскольку информации о размерах полей в ТЗ ГОСТы 34 не содержат, логично применить в данном случае, да и для всех остальных разрабатываемых документов, положения ГОСТ 19.106-78 (п.1.5).
Обозначения разрабатываемых документов - в соответствии с разделом 3 ГОСТ 34.201-89.

2 Программа и методика испытаний
Применяемые ГОСТы: ГОСТ 34.603-92 (п.1.5), РД 50-34.698 (п.2.14).

3 Руководство пользователя (оператора)
Предусмотрен РД 50-34.698 (п.3.4), ГОСТ 19.505-79.

4 Описание применения
Предусмотрен ГОСТом 19.502-78.
В части оформления ссылается на ГОСТ 2.105-78.
Должен иметь Лист утверждения и Титульный лист. Оформление в соответствии с ГОСТ 19.105-78, ГОСТ 19.104-78.

5 Ведомость эксплуатационных документов
Согласно п.2.2 ГОСТ 34.201-89, на каждый комплект документов должна быть составлена ведомость документов.
Применяемые ГОСТы: ГОСТ 19.507-79, РД 50-34.698 (п.2.13).

6 Акт приемки в опытную эксплуатацию
Предусмотрен ГОСТ 24.208-80. Упоминается в РД 50-34.698 (Приложение 2).

Добрый день!
Я помню эту дискуссию, в ней есть много интересного (хотя и много не интересного).
Surgeon, давай не будем уж так решительно размежёвываться - все-таки много общего в нашей деятельности!
И вопросы оформления - тоже важные вопросы. Вот сегодня мне предстоит разрабатывать вариации оформления листов утверждения и титульных листов (заказчик с левой руки покрикивает, что отступаем от ГОСТ, а с правой - пишет - "что-то мне в этих титульных листах не нравится. Попробуйте поиграть (!) со шрифтами"). А поскольку здесь в заводе - лежать под заказчиком и не выступать, займусь "поигрыванием".
Как принято нынче писать - , , ...

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

Порывшись на форуме Философта, нашел интересную с точки зрения истории вопроса ветку: http://forum.philosoft.ru/cgi-bin/forum/ikonboard.cgi?act=ST;f=2;t=1;st=0 . Думаю, Алексею, в частности, будет интересно вспомнить старые споры .

у сВас внизу образца документа, выполненого по ГОСТ 2.104, нет слов Формат и Копировал

И замечательно.
AuthorIT позволяет использовать для колонтитулов вордовский автотекст.
Единожды делается рамка по ГОСТ 2.104-68 с основными надписями по приложениям 2 и 2а, вставляется автотекстом в шаблон AuthorIT.dot и включается в качестве footer'а в сам AuthorIT. После чего вся контора публикует документацию в едином формате - деваться то некуда.
И никаких единых правил не нужно больше. Нечего бюрократию разводить