На всех стадиях жизненного цикла промышленной продукции (программа/комплекс, автоматизированная система и устройство) необходима разработка документации, которая в полной мере должна обеспечить пользователя всеми необходимыми знаниями. От того насколько техническая документация будет полной, информативной и что, немаловажно правильно выполненной, зависит успех продукции на рынке.
Кроме того, разработка технической документации — важная составляющая проектной деятельности при изготовлении и внедрении программного обеспечения или автоматизированных систем. Многие компании на первоначальных стадиях создания и внедрения не придают значения необходимости разработки документации и именно это зачастую «тормозит» вывод на рынок нового продукта.
Существование любой промышленной продукции немыслимо без технической документации. Любая аппаратура, программа или система окружена документами все время: от замысла до деинсталляции или водворения на свалку. Невозможно представить себе создание хоть сколько-нибудь сложного технического решения без проектной документации, а применение без эксплуатационной. Вместе с тем, разработка технической документации требует специфических знаний и умений, а также значительных трудозатрат.
Техническая документация
ТЕХНИЧЕСКАЯ ДОКУМЕНТАЦИЯ И ЕЕ ВИДЫ
Под «технической документацией» понимается пакет документов, который используется при конструировании и (или) проектировании, эксплуатации технических объектов (промышленных сооружений, зданий, иных видов сооружений, программное и аппаратное обеспечение).
Принято считать, что техническая документация подразделяется на несколько видов:
· документация конструкторская. Она включает в себя также ремонтную и эксплуатационную документацию;
· документация технологическая. В свою очередь, она распределяется на документацию, которая содержит информацию по ремонту изделия и организации производства, и документацию с описанием технологического цикла изделия.
ТЕХНИЧЕСКАЯ ДОКУМЕНТАЦИЯ: ЕЕ НАЗНАЧЕНИЕ
В компаниях, чья продукция может повлечь за собой гибель людей или нанесение серьезного материального ущерба, к составу и содержанию техдокументации относятся более или менее ответственно, помня о прокуроре. Таким образом, техдокументация в указанных компаниях, разрабатывается, как минимум:
· во избежание ответственности перед законом — на авиажаргоне такой подход называется «прикрытием задней полусферы»;
· для исключения возможных формальных претензий со стороны заказчика.
Указанный подход обеспечивает все предпосылки к разработке технической документации высочайшего качества.
ТЕХНИЧЕСКАЯ ДОКУМЕНТАЦИЯ: СОСТАВ
В серьезных компаниях, работающих на рынке автоматизированных систем, поставляемых солидным заказчикам, в состав техдокументации входят:
· техническая документация на автоматизированные системы;
· техническая документация на изделия;
· техдокументация на программные изделия — программная документация.
Почему техническая документация — это интересно
Следует отметить, что разработка технической документации на автоматизированные системы в современных условиях неумолимо влечет за собой разработку техдокументации на изделия и программные изделия, за исключением покупных.
С другой стороны, все, что производится в современных условиях, проявляет все больше и больше признаков автоматизированных систем. Мобильный телефон, к примеру, трудно назвать изделием в классическом понимании. Вот ведро или лом — это точно изделия, и ничего больше. Тот же FineReader можно назвать программным изделием только на дистрибутивном носителе. После инсталляции FineReader начинает автоматически распознавать тексты — становится (в совокупности с программным и техническим обеспечением (средствами ПЭВМ) полноценной автоматизированной системой или системой обработки информации.
Источник: studbooks.net
Разработка технической документации
Разработка технической документации
В соответствии с требованиями осуществления сертификации большинства типов продукции, заявитель обязан предоставить определенный комплект документов – технической документации на товар. Под данным определением подразумевается набор документов, который применяется при проектировании и эксплуатации объектов технического назначения.
Два типа технической документации:
- Документация конструкторская (к данному типу относятся Технические условия (ТУ), Руководство по эксплуатации и т.п.),
- Документация техническая (документы, предназначенные для ремонта оборудования).
В случае отсутствия или несоответствия необходимым требованиям, специалисты нашей компании готовы разработать нужный перечень технической документации, запрашиваемый на вашу продукцию. Мы предлагаем услуги по разработке ТУ (технических условий на продукцию), паспорта, руководства по эксплуатации, осуществления приемочных испытаний.
Технические условия (ТУ) для продукции представляют собой необходимую составную часть пакета любой технической документации. ТУ должны отвечать требованиям основных стандартов. Нормативы прописаны в ГОСТ 2.114-95 и ГОСТ Р 51740-2001.
В паспорт технического устройства внесена информация о продукции, которая подтверждает должным образом гарантию изготовителя на данную продукцию. В документе уточняются основные параметры и характеристики, технические условия, сведения о сертификации, условия утилизации.
Руководство по эксплуатации содержит информацию по следующим параметрам: конструкция оборудования, характеристика самого устройства и его комплектующих, принцип действия. А также вносятся сведения, которые нужны для безопасного применения продукции, его утилизации, оценки технического устройства.
Процесс разработки технической документации
Разработка технической документации — это комплекс работ, который включает в себя: определение состава пакета документов, непосредственно саму разработку, сопровождение. Именно понятная, информативная и полная документация – это залог успеха для любого промышленного предприятия. При разработке технической документации необходимо наличие специальных знаний. Часто ведение такой документации требуется на нескольких языках.
Задачи и цели документирования зависят от таких факторов, как тип документируемого технического решения и предназначение. Все технические решения можно разделить на такие группы:
- технические средства (руководства по эксплуатации, по техническому обслуживанию);
- программные продукты (описания для руководства операторов, пользователей, администраторов, программистов, справочные системы, описания языка и прочее);
- аппаратно-программные комплексы (общие описания, инструкции по развертыванию, эксплуатации, разработка технической документации на программное обеспечение, различные технические средства);
- платформы либо прикладные решения (методики, типовые процесс, инструкции, общие описания);
- процессы, оргструктуры, процедуры (регламенты, описания процессов);
- сервисы (общие описания, формуляры, вся рабочая документация, технические и эскизные проекты, технические задания, концепции).
Разработка технической документации, ее предоставление предполагается в двух форматах: электронном и печатном. Количество копий предоставляемых документов должно соответствовать утвержденному. При подаче все печатные экземпляры должны иметь соответствующие подписи, печати, отметки и прочее.
Источник: tms-cs.ru