Стандарты документирования программных средств — Стандартизация программного продукта

СТАНДАРТЫ ДОКУМЕНТИРОВАНИЯ ПРОГРАММНЫХ СРЕДСТВ

Создание программной документации — важный этап, так как пользователь начинает свое знакомство с программным продук­том именно с документации. Для чего предназначен програм­мный продукт, как установить программный продукт, как начать с ним работать — вот одни из первых вопросов, на которые долж­на отвечать программная документация (Installation Guide, Getting Started). Составлением программной документации обыч­но занимаются специальные люди — технические писатели (иногда программную документацию пишут сами программисты или ана­литики). Этот этап является самым неприятным и тяжелым в про­граммистской работе. К сожалению, обычно этому либо не учат совсем, либо в лучшем случае не обращают на качество получае­мых документов должного внимания. Тем не менее владение этим искусством является одним из важнейших факторов, определяю­щих качество программиста.

Умение создавать программную документацию определяет профессиональный уровень программиста. Заказчик не будет вни­кать в тонкости и особенности даже самой замечательной про­граммы. Заказчик будет сначала читать документацию. Большую роль играет в этом и психологический фактор.

Грамотно составленный (точнее, созданный) пакет програм­мной документации избавит вас от многих неприятностей. В ча­стности, избавиться от назойливых вопросов и необоснованных претензий можно, просто отослав пользователя к документации. Это касается прежде всего важнейшего документа — Техническо­го задания. Можно напомнить о многомиллионном иске к ком­пании IBM, который предъявило одно крупное издательство, не удовлетворенное качеством вычислительной техники и програм­много обеспечения. IBM суд выиграла только благодаря тому, что предъявила подписанное обеими сторонами Техническое за­дание. Было это давно, еще в 70-х годах 20 века, однако сути дела это не меняет. На Западе важность программной документации поняли давно, вместе с программным обеспечением поставляется целый пакет документации.

Вообще программную документацию можно разделить по отношению к пользователю на внутреннюю и внешнюю. Вне­шняя — всевозможные руководства для пользователей, техничес­кое задание, справочники; внутренняя документация — та, кото­рая используется в процессе разработки программного обеспе­чения и недоступна конечному пользователю (различные внут­ренние стандарты, комментарии исходного текста, технологии программирования и т.д.).

Когда программист-разработчик получает в той или иной форме задание на программирование, перед ним, перед руководителем проекта и перед всей проектной группой встают вопросы:

• Что должно быть сделано, кроме собственно программы?

• Что и как должно быть оформлено в виде документации?

• Что передавать пользователям, а что — службе сопровождения?

• Как управлять всем этим процессом?

• Что должно входить в само задание на программирование?

На эти и другие вопросы когда-то отвечали государственные стан­дарты на программную документацию — комплекс стандартов 19-й серии ГОСТ ЕСПД. Но уже тогда у программистов была масса пре­тензий к этим стандартам. Что-то требовалось дублировать в доку­ментации много раз (как оказалось — неоправданно), а многое не было предусмотрено, как, например, отражение специфики докумен­тирования программ, работающих с интегрированной базой данных.

Прошло много лет, программирование происходит в среде со­вершенно новых технологий, многие программисты, работая в стиле drag-and-drop, могут годами не видеть текстов своих про­грамм. Это не значит, что исчезла необходимость в их докумен­тировании. Вопросы о наличии хоть какой-то системы, регла­ментирующей эту сторону создания программных средств, про­должают задавать постоянно.

 

Популярные статьи

 

БАНКИ ДАННЫХ
ИНФОРМАЦИОННАЯ ТЕХНОЛОГИЯ УПРАВЛЕНИЯ
ДОСТОИНСТВА И НЕДОСТАТКИ ИМИТАЦИОННОГО МОДЕЛИРОВАНИЯ
ИНФОРМАЦИОННАЯ ТЕХНОЛОГИЯ ОБРАБОТКИ ДАННЫХ
ВИДЫ ОБЕСПЕЧЕНИЯ ИНФОРМАЦИОННЫХ ТЕХНОЛОГИЙ 
ОСНОВНЫЕ ПОНЯТИЯ ТЕОРИИ АЛГОРИТМОВ
ИНФОРМАЦИОННАЯ ТЕХНОЛОГИЯ АВТОМАТИЗАЦИИ ОФИСА
КОМПЛЕКСНОЕ ТЕСТИРОВАНИЕ
КОМПОНЕНТЫ ИНФОРМАЦИОННОЙ ТЕХНОЛОГИИ АВТОМАТИЗАЦИИ ОФИСА
АВТОМАТИЗИРОВАННОЕ РАБОЧЕЕ МЕСТО СПЕЦИАЛИСТА
ЭТАПЫ РАЗВИТИЯ ИНФОРМАТИЗАЦИИ
ПОНЯТИЕ МУНИЦИПАЛЬНОЙ ИНФОРМАЦИОННОЙ СИСТЕМЫ 
РЕЖИМЫ ОБРАБОТКИ ИНФОРМАЦИИ
ФУНКЦИИ АВТОМАТИЗИРОВАННОЙ ИНФОРМАЦИОННОЙ ТЕХНОЛОГИИ
МЕТОДЫ ОБЕСПЕЧЕНИЯ НАДЕЖНОСТИ ПРОГРАММНЫХ СРЕДСТВ
ПРАВИЛА ЗАЩИТЫ ОТ КОМПЬЮТЕРНЫХ ВИРУСОВ
ДОКУМЕНТАЛЬНЫЕ ИНФОРМАЦИОННЫЕ СИСТЕМЫ
ПРОТОКОЛЫ ТЕСТИРОВАНИЯ
ДЕСТРУКТИВНЫЕ ВОЗМОЖНОСТИ ВИРУСОВ
КЛАССИФИКАЦИЯ АВТОМАТИЗИРОВАННЫХ ИНФОРМАЦИОННЫХ ТЕХНОЛОГИЙ
КОНЦЕПТУАЛЬНАЯ, ЛОГИЧЕСКАЯ И ФИЗИЧЕСКАЯ МОДЕЛИ
КОМПЬЮТЕРНЫЕ ТЕХНОЛОГИИ ПОДГОТОВКИ ТЕКСТОВЫХ ДОКУМЕНТОВ
ИНФОРМАЦИОННАЯ ТЕХНОЛОГИЯ ЭКСПЕРТНЫХ СИСТЕМ
ДИАЛОГОВЫЙ РЕЖИМ АВТОМАТИЗИРОВАННОЙ ОБРАБОТКИ ИНФОРМАЦИИ
ТЕХНИЧЕСКОЕ ОБЕСПЕЧЕНИЕ КОМПЬЮТЕРНЫХ СЕТЕЙ