На всех стадиях жизненного цикла промышленной продукции (программа/комплекс, автоматизированная система и устройство) необходима разработка документации, которая в полной мере должна обеспечить пользователя всеми необходимыми знаниями. От того насколько техническая документация будет полной, информативной и что, немаловажно правильно выполненной, зависит успех продукции на рынке.
Кроме того, разработка технической документации - важная составляющая проектной деятельности при изготовлении и внедрении программного обеспечения или автоматизированных систем. Многие компании на первоначальных стадиях создания и внедрения не придают значения необходимости разработки документации и именно это зачастую «тормозит» вывод на рынок нового продукта.
Существование любой промышленной продукции немыслимо без технической документации. Любая аппаратура, программа или система окружена документами все время: от замысла до деинсталляции или водворения на свалку.
Невозможно представить себе создание хоть сколько-нибудь сложного технического решения без проектной документации, а применение без эксплуатационной. Вместе с тем, разработка технической документации требует специфических знаний и умений, а также значительных трудозатрат.
Под «технической документацией» понимается пакет документов, который используется при конструировании и (или) проектировании, эксплуатации технических объектов (промышленных сооружений, зданий, иных видов сооружений, программное и аппаратное обеспечение).
Принято считать, что техническая документация подразделяется на несколько видов:
- документация конструкторская. Она включает в себя также ремонтную и эксплуатационную документацию;
- документация технологическая. В свою очередь, она распределяется на документацию, которая содержит информацию по ремонту изделия и организации производства, и документацию с описанием технологического цикла изделия.
В компаниях, чья продукция может повлечь за собой гибель людей или нанесение серьезного материального ущерба, к составу и содержанию техдокументации относятся более или менее ответственно, помня о прокуроре.
Таким образом, техдокументация в указанных компаниях, разрабатывается, как минимум:
- во избежание ответственности перед законом - на авиажаргоне такой подход называется «прикрытием задней полусферы»;
- для исключения возможных формальных претензий со стороны заказчика.
Указанный подход обеспечивает все предпосылки к разработке технической документации высочайшего качества.
В серьезных компаниях, работающих на рынке автоматизированных систем, поставляемых солидным заказчикам, в состав техдокументации входят:
- техническая документация на автоматизированные системы;
- техническая документация на изделия;
- техдокументация на программные изделия - программная документация.
Следует отметить, что разработка технической документации на автоматизированные системы в современных условиях неумолимо влечет за собой разработку техдокументации на изделия и программные изделия, за исключением покупных.
С другой стороны, все, что производится в современных условиях, проявляет все больше и больше признаков автоматизированных систем. Мобильный телефон, к примеру, трудно назвать изделием в классическом понимании. Вот ведро или лом - это точно изделия, и ничего больше.
Тот же FineReader можно назвать программным изделием только на дистрибутивном носителе. После инсталляции FineReader начинает автоматически распознавать тексты - становится (в совокупности с программным и техническим обеспечением (средствами ПЭВМ) полноценной автоматизированной системой или системой обработки информации.