Лекция 5. Общая характеристика состояния в области документирования программных средств

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

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

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

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

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

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

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

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

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

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

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

Единая система программной документации — это комплекс государственных стандартов, устанавливающих взаимоувязанные правила разработки, оформления и обращения программ и про­граммной документации.

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

В состав ЕСПД входят:

· основополагающие и организационно-методические стандарты;

· стандарты, определяющие формы и содержание программных
документов, применяемых при обработке данных;

· стандарты, обеспечивающие автоматизацию разработки про­граммных документов.

Большая часть стандартов ЕСПД морально устарела. ЕСПД нуждается в полном пересмотре на основе стандарта ИСО/МЭК 12207-95 на процессы жизненного цикла ПС.

· Тем не менее, до пересмотра всего комплекса многие стандар­ты могут с пользой применяться в практике документирования ПС.

Надо сказать, что наряду с комплексом ЕСПД официальная нормативная база РФ в области документирования ПС и в смеж­ных областях включает ряд перспективных стандартов (отече­ственного, межгосударственного и международного уровней).

Международный стандарт ISO/IEC 12207:1995 на организа­цию ЖЦ продуктов программного обеспечения (ПО), казалось бы, весьма неконкретный, но вполне новый и отчасти «модный» стандарт.