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

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

Впервые опубликована в журнале «Мир Автоматизации» № 4 за 2006 год под названием «Ваш выбор? Часть II», чуть позже - здесь.

Статья «Автоматизация разработки технической документации. Часть I», впервые опубликованная 24 января 2005 года, открыла «пишущей братии» рунета принципиально новые практические приемы разработки технической документации. В статье, подготовленной на основе первого (в этой стране) успешного опыта реализации идеи автоматизации документирования, рассмотрены:

• современная (на момент публикации) ситуация в области разработки технической документации;
• предпосылки к автоматизации процессов жизненного цикла технической документации;
• собственно практическая реализация идеи автоматизации документирования.

Настоящий вариант статьи слегка скорректирован с учетом нынешних реалий.

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

В настоящей статье определена обобщенная структура руководства пользователя программы (в ГОСТ 19 такой документ отсутствует) на основе сравнительного анализа ГОСТ 19 и IEEE Std 1063-2001, а также с учетом рекомендаций «манифеста Юрия Кагарлицкого». В результате анализа подтверждено, что «устаревшие» стандарты 19-й системы, если научиться грамотно их применять, во многом превосходят суперсовременный IEEE Std 1063-2001 и вполне пригодны для подготовки руководств на программы с графическим интерфейсом пользователя.

Впервые опубликована 14 февраля 2005 года. В нынешней редакции изменены названия отдельных разделов и подразделов.

Владение терминологией - показатель уровня квалификации специалиста.

«Техническая документация»

В разделе представлены свыше 900 (девятисот) терминов и определений, применяемых при разработке и документировании изделий, программных изделий и автоматизированных систем. Термины и определения заимствованы из основополагающих нормативно-технических документов (ГОСТ, Р, РД и т.д.) и опубликованы в алфавитном порядке. Для каждого термина приведена ссылка на пункт первоисточника, особо сложные дополнены пояснениями.