• Перевод

Введение

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

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

Итак - эти 7 правил:

1. Скука убивает
2. Прежде чем начать, выясните точно для себя, какие действия вы ожидаете от читателя, осилившего ваш труд
3. Пишите в соответствии с правильно сформированной структурой
4. Избегайте неоднозначных местоимений
5. Ясность = иллюстрации + слова
6. Когда имеете дело с понятиями, концепциями и т.п., используйте логическую иллюстрацию и пример
7. Не опасайтесь переделок

1. Скука убивает

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

Мне нравится юмор, поэтому я стараюсь сделать мои литературные технические «творения» забавными, но, конечно, без ущерба для ясности. Пытаюсь разговаривать с читателем, а не поучать его. Пишу о делах, которые, действительно, имеют значение для меня. Широко использую иллюстрации, чтобы предотвратить неясность для читателя.

И снова, всегда стараюсь сделать процесс чтения увлекательным. Я всегда помню, что пишу в конкурентной среде. Имеется множество контента, стремящегося привлечь внимание читателей. Таким образом, мой совет по правилу № 1: если ваши тексты будут интересны вам, то они будет интересными и для читателя.

2. Прежде чем начать, выясните точно для себя, какие действия вы ожидаете от читателя, осилившего ваш труд

Поэтому чрезвычайно полезно для вас чётко определиться, какие действия вы ожидаете от читателя после завершения процесса чтения. Изложите ваше намерение с самого начала. Не оставляйте читателя гадать. Ваше заявление может быть простым и очевидным, как, например: «после прочтения данной статьи вы сможете [впишите свой вариант]». Если вы определились с действиями, ожидаемыми от читателя после прочтения, то процесс написания будет для вас легче с самого начала.

3. Пишите в соответствии с правильно сформированной структурой

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

Имеются два правила структурирования, которые я всегда использую:

1. Раздел подуровня требует наличия, как минимум, одной позиции.
2. На каждом уровне структуры должно быть, как минимум, два предложения.

Хотелось бы уточнить. Листинг 1 внизу является примером структуры, которая нарушает первое правило: раздел подуровня требует наличия, как минимум, одной позиции .

Листинг 1: неправильно сформированная структура

1.1. Шаги, требуемые для приготовления шипучего напитка

1.1.1. Подготовка ингредиентов

1.1.2. Смешивание ингредиентов шипучего напитка

1.1.3. Подача шипучего напитка

Обратите внимание, что в листинге 1 уровень 1 имеет одиночный подуровень: "1.1. Шаги, требуемые для приготовления шипучего напитка ". Такая структура является нарушением первого правила. Чтобы подуровень был правильно сформирован, в разделе должна быть, как минимум, ещё одна позиция. Другими словами, это значит, что на любом данном уровне должно быть, как минимум, два подуровня.

Посмотрите листинг 2 внизу. Обратите внимание, что у уровня 1 теперь имеются три подуровня, из которых раздел «Смешивание ингредиентов шипучего напитка» содержит позиции. Одиночный уровень «Шаги, требуемые для приготовления шипучего напитка» удалён.

Может возникнуть вопрос: «Где раздел Шаги, требуемые для приготовления шипучего напитка» ?.. Видно, что этот раздел теперь не является позицией структуры, а перешёл в контент исходного раздела, как показано в листинге 2 внизу.

Листинг 2: правильно сформированная структура, нарушающая правило двух предложений

1. Приготовление апельсиново-клюквенно-мандаринового шипучего напитка

Раздел внизу описывает процесс, который надо соблюсти для приготовления апельсиново-клюквенно-мандаринового шипучего напитка.

1.1. Подготовка ингредиентов

1.3. Подача шипучего напитка

Обратите внимание, что, хотя листинг 2 демонстрирует структуру с правильно сформированным подуровнем, в контенте раздела уровня 1 имеется только одно предложение. Присутствие одного единственного предложения в контенте раздела структуры нарушает второе правило структурирования - "На каждом уровне структуры должно быть, как минимум, два предложения ".

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

Листинг 3: правильно сформированная структура, выполняющая правило двух предложений

1. Приготовление шипучего апельсиново-клюквенно-мандаринового напитка

Апельсиново-клюквенно-мандариновый шипучий напиток может доставить большое удовольствие в жаркий летний день. Напиток состоит из природных компонентов без искусственных ароматизаторов. Апельсиново-клюквенно-мандариновый шипучий напиток не только вкусный, но и чрезвычайно полезный!

Разделы внизу описывают процесс, который надо соблюсти для приготовления апельсиново-клюквенно-мандаринового шипучего напитка.

1.1. Подготовка ингредиентов

1.2. Смешивание ингредиентов шипучего напитка

1.3. Подача шипучего напитка

Почему я так беспокоюсь о правильной структуре и о, по крайней мере, двух предложениях на каждом уровне? Во-первых, соблюдение правила подуровня побуждает меня быть предельно чётким в логической сегментации моего труда. Следование правилу подуровня способствует также тому, что мой текст соединяет мои идеи с общей линией, которая имеет смысл и легко прослеживается.

Во-вторых, правило двух предложений требует от меня написать текст, который является привлекательным, подробным и целесообразным. При записи в «одно предложение» нередко теряются подробности. И, если не рассматривать афоризмы, текст в «одно предложение» - не самое интересное чтение.

4. Избегайте неоднозначных местоимений

Рассмотрим абзац в листинге 4.

Листинг 4: абзац с неоднозначными местоимениями

Трафальгаборы являются базовой компонентой фрейма Вибитатов. Эта статья показывает, чем они являются и как их использовать.

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

Применительно к абзацу вверху я не удивлюсь, если вы спросите: «Что это за штука „Трафальгабор“? А что такое „Вибитата“? О чём, вообще, этот абзац? О том, как использовать Трафальгаборы? Или о том, как использовать Вибитаты? Или о том, как использовать и те, и другие? Бред какой-то. Вернусь я лучше на свою страницу в Фейсбуке».

Если читатель при чтении вашего описания вынужден тратить время на выяснение, что же вы пытаетесь ему сообщить, то мало того, что информативный поток будет нарушен, но и читатель, скорее всего, будет запутан. Как только вы привели читателя в замешательство, вы его потеряли. Всё другое в мире, направленное на привлечение внимания вашего читателя, становится для него более притягательным, чем ваше творение. Щелчок по кнопке «Далее» - и ваша работа остаётся непрочитанной.

В листинге 4 замешательство порождается неоднозначным использованием местоимения «они» во втором предложении. К чему относится здесь «они» - к Трафальгаборам, Вибитатам или к обоим? Помните, что читатель ничего не знает, что такое Трафальгаборы или Вибитаты. (См. рис. 1 внизу.)

Рис. 1. Использование неоднозначных местоимений запутывает техническое описание

Решение проблемы простое. Посмотрите листинг 5 внизу. Неоднозначное местоимение удалено. Ясность восстановлена.

Листинг 5: устранение неоднозначных местоимений

Трафальгаборы являются базовой компонентой фрейма Вибитатов. Эта статья рассказывает, что такое Трафальгаборы и как их использовать.

Осторожно! Неоднозначное использование местоимений ведёт к техническому описанию, приводящему в замешательство.

5. Ясность = иллюстрации + слова

Я не удивлюсь, если вы будете немного растеряны. Эта фотография, действительно, озадачивает. Вы знаете все отдельные компоненты, но вам неясно, что они все вместе значат. Такова природа любой иллюстрации. Картинке без слов не хватает контекста.

При обращении к иллюстрациям читателям требуется контекст, чтобы внести ясность. Недопустимо, чтобы читатель напрасно тратил время или усилия, пытаясь выяснить, о чём же рассматриваемая графика. Самым лёгким путём устранить неясность с иллюстрациями является обеспечить их надписями.

Посмотрите на рис. 2 внизу. Он представляет собой то же самое фото. Но здесь уже нет вопроса, о чём оно.

Рис. 2. Инструменты и ингредиенты, требуемые для приготовления апельсиново-клюквенно-мандаринового шипучего напитка

Применительно к техническим описаниям я считаю полезным все иллюстрации снабжать пронумерованными описательными надписями.

Не помещайте надписи, содержащие только цифры. Используйте в надписи, как цифры, так и описательный комментарий. Также не допускайте появления изолированных иллюстраций. Изолированной иллюстрацией считается такая, которая расположена в техническом описании, но ссылка на которую в тексте отсутствует.

Вставляя иллюстрацию в ваше описание, следите за тем, чтобы сослаться на неё в тексте указанием её номера и таких слов как «выше», «вверху», «ниже», «внизу». Недопустимо вынуждать читателя при чтении вашей работы тратить время на привязку иллюстрации к тексту или на её поиск в описании. Если вы добавляете в текст, скажем, «Рис. 4», то убедитесь, что где-то в тексте сказано что-то вроде «см. рис. 4 внизу».

Примечание : глаз привлекают изображения

Десять лет назад я работал в группе, которая писала пользовательское руководство (под типографское издание) для очень, очень большого изготовителя компьютеров. Все руководства подвергались формальному количественному исследованию на удобство пользования. Тогда от специалистов по взаимодействию с пользователем я узнал, что, когда человек читает руководство, глаз его идёт сначала к изображениям. Лишь затем читатель смотрит на текст вокруг этого изображения. Поэтому авторы того руководства пытались обеспечить, чтобы на каждой его странице была хотя бы одна картинка.

6. Когда имеете дело с понятиями, концепциями и т.п., используйте логическую иллюстрацию и пример, логическую иллюстрацию и пример

Применим это правило для описания понятия элементарной алгебры.

Понятие «транзитивность отношения равенства» представляет собой следующее:

Если A = B и B = C, то A = C;

Теперь приведём логическую иллюстрацию, описывающую это понятие (см. рис. 3).

Рис. 3. Транзитивность отношения равенства является фундаментальным принципом элементарной алгебры

Листинг 6 ниже показывает несколько конкретных примеров для закрепления понимания рассматриваемого положения.

Листинг 6: некоторые конкретные примеры транзитивности отношения равенства

• Если 7 = 3 + 4 и 3 + 4 = 5 + 2, то 7 = 5 + 2;
• Если 12 + 5 = 7 + 10 и 7 + 10 = 6 + 11, то 12 + 5 = 6 + 11;
• Если x + y = z и z = 2a, то x + y = 2a.

Теперь рассмотрим понятие, которое ближе к разработке программного обеспечения и несколько труднее для понимания. Таким понятием является наследование моделей объектов проекта (POM = Project Object Model) в Maven (система автоматизированной сборки проектов). Пример 1 ниже представляет рассматриваемое понятие и даёт логическую иллюстрацию, описывающую это понятие. В конце представлена ещё одна иллюстрация, показывающее конкретное использование POM-файлов в ситуации наследования.

Пример 1: выдержка из технического описания наследования моделей объектов проекта (POM) в Maven (система автоматизированной сборки проектов)

Представление наследования POM-файла

POM -файл является XML-файлом, используемым для описания Maven -проекта и для работы с этим проектом. Можно задать, чтобы некоторый Maven-проект наследовал настройки из отдельного родительского POM-файла. Способность наследовать настройки из родительского POM-файла называется POM-наследованием. Вы используете элемент В вашем POM-файле, чтобы задать родительский POM-файл, из которого должно произойти наследование настроек.

Рис. 4 ниже показывает иерархию некоторого условного проекта, являющуюся примером задания мастер-файла РОМ, из которого другие РОМ-файлы могут наследовать общие настройки.

Рис. 4. Можно назначить мастер-файл РОМ, из которого будет происходить наследование общих настроек

Рис. 5 ниже показывает содержание POM.xml-фалов для Maven-проектов stooges-web, stooges-api и stooges-dal. Каждый проект сконфигурирован на использование элемента Для наследования настроек из stooges-project.

Рис. 5. Использование элемента Для управления Maven-проектом с целью наследования настроек из внешнего РОМ-файла

Итак, если требуется предельно ясно представить какое-то понятие, то необходимо включить в текст иллюстрации и примеры.

7. Не опасайтесь переделок

Можно сказать об этой работе, перефразируя известную цитату Томаса Эдисона : «Написание технического текста - это на 10% литературное творчество и на 90% переработка!»

1. Составляю структуру, как минимум, до второго уровня (если удаётся, то и до третьего);
2. Добавляю иллюстрации в структуру для каждого понятия;
3. Делаю подписи под иллюстрациями;
4. Пишу текст в соответствии со структурой, соблюдая правило двух предложений и подстраивая структуру под текст;
5. Редактирую, переделываю;
6. Отправляю результат специалисту по рассматриваемой теме на рецензирование (специалистом по рассматриваемой теме является лицо, которое в состоянии выявить неточности и неясности в описании);
7. Снова редактирую работу на основе отзыва рецензента (рецензентов).

В соответствии со ст. 743 Гражданского кодекса РФ подрядчик обязан осуществлять строительство и связанные с ним работы в соответствии с технической документацией (сюда относится проектная, сметная, исполнительная документация ), определяющей объем, содержание работ и другие, предъявляемые к ним требования.

Проектная организация «Галактион» предлагает полный спектр услуг по составлению технической документации для строительства по всей России.

Проектно сметная документация

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

Разработка проектно сметной документации

В окончательный комплект проектно-сметной документации, как правило, входят проектная и рабочая документация. Эти виды документации дополняют друг друга:

• В проектную документацию входят основные разделы по организации строительства ("Пояснительная записка", "Проект организации строительства", "Мероприятия по обеспечению пожарной безопасности", "Смета на строительство объектов капитального строительства" и т.д).
• Рабочая документация содержит рабочие чертежи, документы, спецификации и является основанием для реализации принятых в проекте решений.

Сметная документация

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

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

Разработка сметной документации

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

Ресурсный метод это калькулирование стоимости ресурсов в ценах и тарифах по состоянию на базисный уровень цен и (или) текущих (прогнозных) ценах. Калькулирование ведётся на основе потребности в материалах, изделиях, конструкциях, времени эксплуатации строительных машин и механизмов, затрат труда рабочих. Эти ресурсы определяются на основании проектных данных, нормативных источников. Базисно-индексный метод это применение к стоимости, определённой на базисном уровне цен, текущих или прогнозных индексов изменения стоимости. Ресурсно-индексный метод это сочетание ресурсного метода с системой индексов цен на ресурсы, расход которых определяется в соответствии с проектными решениями. Индексы определяются по отношению к базисному и предшествующему уровню. Приведение в уровень текущих цен или прогнозных цен производится путём применения к стоимости ресурсов соответствующих индексов изменения стоимости. Базисно-компенсационный метод это суммирование стоимости, исчисленной в базисном уровне, и определяемых расчётами дополнительных затрат, связанных с изменением цен и тарифов на потребляемые в строительстве ресурсы. Метод объектов-аналогов это использование стоимостных и ресурсных показателей по зданиям, сооружениям, проектно-технологическим модулям, элементам затрат по объектам, аналогичным проектируемому объекту по функциональному назначению, конструктивной характеристике и близким по объёмно-планировочным показателям.

Кроме того, могут понадобиться сметные нормативы.

Сметные нормативы

Сметными нормативами обобщенно называется комплекс сметных норм и расценок, объединенных в отдельные сборники. Они наравне с правилами и положениями, включающими в себя необходимые требования, являются основой для подсчета сметной стоимости в строительстве.

Главная функция сметных нормативов - определение нормативной потребности в ресурсах, которые минимально необходимы и достаточны для осуществления необходимых видов работ. Они используются в качестве основы для дальнейшего перехода к стоимостным показателям.

Сметные нормативы Российской Федерации делятся на несколько типов:

• ГСН — разрабатываются и вводятся Госстроем России;
• ОСН — разрабатываются и вводятся в действие министерствами, а также иными органами федерального управления. Они относятся к производственно-отраслевому строительству, ведущемуся в пределах той отрасли, для которой нормы и разработаны;
• ТСН — их вводят органы исполнительной власти субъектов РФ в отношении строительства, которое ведется на территории конкретного региона. К примеру, существуют территориальные сметные нормативы для Москвы;
• ФСН — они учитывают реальные условия и специфику работы конкретного предприятия-исполнителя работ, которое находится в ведомственном подчинении.

И конечно, не стоит забывать, что помимо сметы, вам может понадобиться и другая сметная документация, например, формы кс 2, кс3 и так далее.

КС 2 и КС 3 что это?

Однако при заполнении форм КС-2 и КС-3 нужно помнить, что эти документы фиксируют не столько факт передачи работ от подрядчика к заказчику, а используются для расшифровки всех произведенных работ и их стоимости.

Образец сметы

• Локальная смета на ремонт помещения
• Полный локальный сметный расчет на монтажные работы
• Полный локальный сметный расчет на пусконаладочные работы

Проверка сметной документации

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

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

Проектная документация

Проектная документация на объекты капитального строительства производственного и непроизводственного назначения должна включать в себя 12 разделов:

• Раздел 2 "Схема планировочной организации земельного участка"
• Раздел 3 "Архитектурные решения"
• Раздел 4 "Конструктивные и объемно-планировочные решения
• Раздел 5 "Сведения об инженерном оборудовании, о сетях инженерно-технического обеспечения, перечень инженерно-технических мероприятий, содержание технологических решений"
  • подраздел "Система электроснабжения";
  • подраздел "Система водоснабжения";
  • подраздел "Система водоотведения";
  • подраздел "Отопление, вентиляция и кондиционирование воздуха, тепловые сети";
  • подраздел "Сети связи";
  • подраздел "Система газоснабжения";
  • подраздел "Технологические решения".
• Раздел 6 "Проект организации строительства"
• Раздел 7 "Проект организации работ по сносу или демонтажу объектов капитального строительства"
• Раздел 8 "Перечень мероприятий по охране окружающей среды"
• Раздел 9 "Мероприятия по обеспечению пожарной безопасности"
• Раздел 10 "Мероприятия по обеспечению доступа инвалидов"
• Раздел 10(1) "Мероприятия по обеспечению соблюдения требований энергетической эффективности и требований оснащенности зданий, строений и сооружений приборами учета используемых энергетических ресурсов"
• Раздел 11 "Смета на строительство объектов капитального строительства"
• Раздел 12 "Иная документация в случаях, предусмотренных федеральными законами"

Проектная документация на линейные объекты капитального строительства и требования к содержанию этих разделов состоит из 10 разделов:

• Раздел 1 "Пояснительная записка"
• Раздел 2 "Проект полосы отвода"
• Раздел 3 "Технологические и конструктивные решения линейного объекта. Искусственные сооружения"
• Раздел 4 "Здания, строения и сооружения, входящие в инфраструктуру линейного объекта
• Раздел 5 "Проект организации строительства
• Раздел 6 "Проект организации работ по сносу (демонтажу) линейного объекта
• Раздел 7 "Мероприятия по охране окружающей среды"
• Раздел 8 "Мероприятия по обеспечению пожарной безопасности
• Раздел 9 "Смета на строительство"
• Раздел 10 "Иная документация в случаях, предусмотренных федеральными законами"

Разработка проектной документации

Подготовка проектной документации – очень важная составляющая при планировании строительных работ. От того, насколько квалифицировано поставлены требования к проекту, зависит и долговечность будущего здания, и его эстетичность. Проектная компания «Галактион» относятся к этому этапу с особой тщательностью и вниманием, поскольку любая ошибка при составлении проектной документации – это и неоправданные осложнения при проведении строительных работ, и повышенные затраты.

Рабочая документация

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

Разработка рабочей документации

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

Контроль строительных работ

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

ВВЕДЕНИЕ

На всех стадиях жизненного цикла промышленной продукции (программа/комплекс, автоматизированная система и устройство) необходима разработка документации, которая в полной мере должна обеспечить пользователя всеми необходимыми знаниями. От того насколько техническая документация будет полной, информативной и что, немаловажно правильно выполненной, зависит успех продукции на рынке.

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

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

ТЕХНИЧЕСКАЯ ДОКУМЕНТАЦИЯ И ЕЕ ВИДЫ

Под «технической документацией» понимается пакет документов, который используется при конструировании и (или) проектировании, эксплуатации технических объектов (промышленных сооружений, зданий, иных видов сооружений, программное и аппаратное обеспечение).

· документация конструкторская. Она включает в себя также ремонтную и эксплуатационную документацию;

· документация технологическая. В свою очередь, она распределяется на документацию, которая содержит информацию по ремонту изделия и организации производства, и документацию с описанием технологического цикла изделия.

ТЕХНИЧЕСКАЯ ДОКУМЕНТАЦИЯ: ЕЕ НАЗНАЧЕНИЕ

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

· во избежание ответственности перед законом - на авиажаргоне такой подход называется «прикрытием задней полусферы»;

· для исключения возможных формальных претензий со стороны заказчика.

Указанный подход обеспечивает все предпосылки к разработке технической документации высочайшего качества.

ТЕХНИЧЕСКАЯ ДОКУМЕНТАЦИЯ: СОСТАВ

В серьезных компаниях, работающих на рынке автоматизированных систем, поставляемых солидным заказчикам, в состав техдокументации входят:

· техническая документация на автоматизированные системы;

· техническая документация на изделия;

· техдокументация на программные изделия - программная документация.

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

С другой стороны, все, что производится в современных условиях, проявляет все больше и больше признаков автоматизированных систем. Мобильный телефон, к примеру, трудно назвать изделием в классическом понимании. Вот ведро или лом - это точно изделия, и ничего больше. Тот же FineReader можно назвать программным изделием только на дистрибутивном носителе. После инсталляции FineReader начинает автоматически распознавать тексты - становится (в совокупности с программным и техническим обеспечением (средствами ПЭВМ) полноценной автоматизированной системой или системой обработки информации.

Что такое техническая документация? Техдокументация - это «совсем не то, о чем вы подумали». И совсем уж не то, что предлагают нам всяческие ...педии и прочие сетевые словари. Точные, исчерпывающие и узаконенные по технической тематике обитают исключительно в. Как удобнее их искать? Редакция от 20.06.2018.

Что такое техническая документация?

Создан 01.10.2009 9:48:27

«техническая документация» послужит нам всего лишь в качестве примера, применимого к технической терминологии в целом.

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

В наиболее приемлемом (из всех найденных) определении техдокументации «по Педевикии», изображенном на рисунке ниже, предельно низок - в разделе Стандарты ссылки на нормативные документы имеются, но не на те, на которые должны быть. Отсутствуют ссылки на самые важные, а именно на:

• руководящий документ;
• на автоматизированные системы (КСАС), в состав которого входят и.

Примечание от 12.01.2015 г. - В ходе дальнейшего «потрошения» для пополнения открываются новые, в частности:

Техническая документация по Р 50-605-80-93

В документе Р 50-605-80-93 Система разработки и постановки продукции на производство. Термины и определения техдокументация представлена как «Совокупность, необходимая и достаточная для непосредственного использования на каждой. К технической документации относятся и, и т.д. Техническую документацию можно подразделить на исходную, проектную, информационную. К исходной относятся: , исходные, по разработке продукции, выполняемые в процессе, техническое задание. К проектной документации относятся: для конструкторской документации - , ; для технологической - предварительный проект. К рабочей документации - , . К информационной документации - , расчета экономической эффективности и цен () продукции, каталоги, отчет о, акты и об, о и др. [из п. 1.6.1 Р 50-605-80-93]»

Но Р 50-605-80-93 дает определение техдокументации на в целом. Для, являющихся частным случаем промышленной продукции, предусмотрены ЦЕЛЫХ ДВА определения

Техническая документация на автоматизированную систему по ГОСТ 34.003-90 и ГОСТ 34.201-89

Согласно ГОСТ 34.003-90 техническая документация на АС есть «Комплект взаимоувязанных , полностью определяющих технические к, проектные и организационные решения по созданию и АС [из п. 5.1 ГОСТ 34.003-90]»

В ГОСТ 34.201-89 имеется иная трактовка, а именно: «Документация на - комплекс взаимоувязанных , в котором полностью описаны все решения по созданию и системы, а также документов, подтверждающих системы и готовность ее к () [из п. 1 прил. 1 ГОСТ 34.201-89]».

Довольно странно видеть в едином 34-м комплексе стандартов два определения одного и того же термина, правда, в одном из них идет речь о комплексе документов, а в другом - о комплекте

Техническая документация на военную технику по Р 50-605-80-93

Особый случай. Потому и определение техдокументации на нее идет отдельной статьей - «Совокупность, создаваемых для непосредственного использования их на различных. Основными видами на военную технику являются:

• , включающая всех категорий и, нормативно-технические документы системы общих технических Министерства обороны (НТД системы ОТТ МО), () задания, нормы, методические указания, и другие документы, в установленном порядке;
• , определяющая назначение, состав, устройство и принцип действия, а также содержащая необходимые данные для его, изготовления, (применения) и. Конструкторская документация включает в себя проектную (,), рабочую (опытного или, а также или), (с необходимыми сведениями по устройству и рациональной эксплуатации изделия военной техники) и (для проведения ремонта на специализированных ремонтных) документацию;
• , определяющая требования к и, а также устанавливающая каждой технологической операции;
• , содержащая сведения, необходимые для разработки, изготовления, эксплуатации и.

[из п. 2.5.3 Р 50-605-80-93]»

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

Техническая документация по ГОСТ Р 54089-2010

Еще одно очень милое, краткое и емкое определение техдокументации - «Совокупность и, используемой для изготовления, и [из п. 3.1.12 ГОСТ Р 54089-2010]».

• для поиска соответствующей случаю нормативной документации достаточно сделать запрос в любой с «гост термины и определения» - откроется список. Это быстрый, но не отличающийся особой способ. Более того, терминология частенько содержится в ГОСТах, которые могут быть и не найдены по указанным;
• более сложным и запутанным является поиск терминологии в Общероссийском классификаторе стандартов. Но результат поиска по запросу «термины и определения» в подходящем разделе ОКСа будет и исчерпывающим по своей полноте.

Вот одна из ссылок на ОКС - standartgost.ru/0/101-obscherossiyskiy_klassifikator_standartov

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

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

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

Состав технической документации

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

Руководство по эксплуатации технического средства
Формуляр
Паспорт
Технические условия на производство изделия
Спецификация
Другие документы, перечень которых колеблется в зависимости от специфики производства и проектирования того или иного оборудования.

Сейчас документация для оборудования может включать, кроме стандартных, массу специфических документов, перечень которых здесь было бы приводить излишне. Мы поможем разработать абсолютно любой документ, который вам необходим. Наши специалисты обладают богатым опытом и незаурядными знаниями, которые готовы предоставить в ваше распоряжение!

Техническая документация на оборудование с нами перестанет быть для вас проблемой, а станет реальным средством для продвижения бизнеса, упрощения процесса производства и проектировки!

Как разрабатывается?

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

На данный момент существует:

Проектная документация
Содержащая необходимые сведения для разработки изделия.