Оформление документации

  • Как оформить проект?
  • Как оформить рабочую документацию?
  • Какие существуют варианты оформления и когда их использовать?
  • Как можно ускорить выполнение элементарных оформительских работ?
  • Где взять шаблоны различных документов?

  Эти и многие другие вопросы возникают не только у людей, начинающих заниматься проектированием. Нередко и опытные специалисты вынуждены «гуглить» в поисках необходимых обоснований своих решений в ответ на замечания различных проверяющих, которые в принципе такие же люди, как и мы, и тоже могут ошибаться, иногда даже неосознанно :) А наша задача состоит в правильном оформлении проектных документов (желательно с минимальными затратами своего труда) и, при необходимости, в составлении грамотных ответов на предъявленные замечания.

  Вы обратили внимание, что заказчики стали грамотнее? Если, например, при проектировании ВСТО-I в нулевых годах мы получали лишь замечания типа несоответствия наименования листа в графе 4 штампа (основной надписи) и в ведомости рабочих чертежей, то сейчас замечания стали более предметными.

  Первую попытку публичного изложения своих взглядов на оформление рабочей документации я сделал в 2006-м году на сайте http://www.proekt-ohrana.narod.ru, который сейчас уже явно устарел. Это позволило привлечь внимание коллег, в спорах с которыми на форумах, в аське и по почте оттачивалась аргументация в пользу тех или иных решений и подходов. В середине марта 2011-го года мне удалось принять участие в семинаре в ОАО «ЦНС» (Центр методологии нормирования и стандартизации в строительстве), познакомиться с разработчиками базовых ГОСТов СПДС на оформление документации (типа ГОСТ Р 21.1101-2009). В дискуссиях с ними и с коллегами по цеху закрепилось определённое представление по данному вопросу, которое и предлагается на Ваш суд далее. Кстати, ряд моих замечаний Николай Иванович Сорокин ещё на семинаре пообщелал включить в очередной изм ГОСТа 21.1101, например, сократить ширину боковой надписи ("Согласовано") с 20 до 15 мм, чтобы она помещалась в пределах печатаемой области принтеров. Это изменение вошло в редакцию 2013 года.

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

 Сразу скажу, что по основному месту работы я работаю в основном с разделами:

  • - охранная сигнализация;
  • - контроль и управление доступом;
  • - охранное телевидение (телевизионное наблюдение), 
  • поэтому примеры буду приводить соответствующие. Базовые же принципы применимы к любым другим разделам.

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

  В конце многих статей я привожу примеры оформления документации, шаблоны или написанные мною небольшие программы, ускоряющие выполнение элементарных операций. Буду рад услышать отзывы, положительные или отрицательные :)

 ЧИТАТЬ ДАЛЕЕ: "НОРМАТИВНЫЕ ДОКУМЕНТЫ"

Комментарии

Я случайно забрел на Ваш сайт, искал как правильно оформить кабельный журнал и вообще какие виды кабельных журналов бывают. Ваш сайт мне очень понравился, грамотные и парвильные статьи и ссылки на нормативные документы. С этого момента я постараюсь быть активным пользователем Вашего сайта.
Единственый ндостаток - нет имени создателя или того с кем общаешся. А в остальном все просто отлично.

 Моё имя (и создателя, и того, с кем общаетесь), а также почтовый ящик висят внизу на каждой странице сайта. НапИшите свой материал - после "Published by" в начале статьи будет Ваше имя:).
 Увидеть меня "вживую" можно на странице "Семинар САПРяжение" в ролике с моим выступлением на встрече Сообщества пользователей Autodesk САПРяжение:)
 Что касается обсуждений, то каждый сам для себя решает, скрываться за ником или представить себя. Я даю возможность писать даже без регистрации, но за это вынужден был ввести предмодерацию - спам льётся рекой. Присоединяйтесь к обсуждению! Немало людей с флагом "что за чушь здесь написана" ввязывались в дискуссию, но когда начинали искать в нормативных документах аргументы в обоснование своей позиции, сами понимали, что заблуждались :) Давайте бороться с ламерским подходом "мы всегда так делали, нас так научили".

Добавить комментарий

Filtered HTML

  • Use [collapse] and [/collapse] to create collapsible text blocks. [collapse collapsed] or [collapsed] will start with the block closed.
  • Адреса страниц и электронной почты автоматически преобразуются в ссылки.
  • Generate stylish tooltips. Format: [qtip:Text to display on page|Tooltip title (optional)|Text to appear in tooltip]
  • Допустимые HTML-теги: <a> <em> <strong> <cite> <code> <ul> <ol> <li> <dl> <dt> <dd> <h2> <h3>
  • Строки и абзацы переносятся автоматически.

Plain text

  • HTML-теги не обрабатываются и показываются как обычный текст
  • Адреса страниц и электронной почты автоматически преобразуются в ссылки.
  • Строки и абзацы переносятся автоматически.
CAPTCHA
Этот вопрос проверяет, что Вы человек.