Проект национального стандарта «Стиль изложения документации пользователя программного средства. Общие требования»

Кому и для чего нужен стандарт на стиль?

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

Пользователь стандарта Задачи Способ применения
Руководитель отдела документирования Достижение устойчивости качества документации, выпускаемой отделом. Унификация стиля документации пользователя в компании. Предъявление четких единых требований к результатам работы всех сотрудников отдела Включение ссылки на предлагаемый стандарт в стандарт организации либо разработка на его основе собственного стандарта на стиль. Ознакомление со стандартом всех сотрудников отдела
Менеджер по продукту Обеспечение соответствия корпоративному стилю и качества документации пользователя на программные продукты компании Включение ссылки на предлагаемый стандарт в стандарт организации либо разработка на его основе собственного стандарта на стиль
Руководитель проекта по разработке заказной автоматизированной системы (программы) Формализация требований к стилю изложения документации пользователя, предотвращение конфликтов с представителем заказчика при сдаче проекта Включение ссылки на предлагаемый стандарт в техническое задание, в раздел «Требования к документированию»
ИТ-менеджер Обеспечение единообразия и качества документации пользователя при заказе автоматизированных систем (программ) внешним исполнителям или собственным разработчикам Включение ссылки на предлагаемый стандарт в техническое задание, в раздел «Требования к документированию»

Получение проекта национального стандарта

Материал Формат Объем, КБ
Проект национального стандарта PDF 800

Уведомление завершении публичного обсуждения национального стандарта

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

1. Разработчики:

2. Объект стандартизации с указанием кодов ОКС: документация пользователя программного средства, код ОКС 35.080.

3. Наименование проекта в области стандартизации: проект национального стандарта Российской Федерации «Информационные технологии. Системная и программная инженерия. Стиль изложения документации пользователя программного средства. Общие требования».

4. Положения, отличающиеся от положений соответствующих международных аналогов: международных аналогов не имеет.

5. Копии доработанного проекта документа в области стандартизации и перечня замечаний можно получить: Россия, 117997, Москва, ул. Профсоюзная, д. 84/32. Телефон: +7 (495) 787-81-79. Факс: +7 (495) 333-62-78. Адрес электронной почты: standard@philosoft.ru.

Дата публикации на сайте 06.07.2007

Уведомление о разработке проекта национального стандарта

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

1. Разработчики:

2. Объект стандартизации с указанием кодов ОКС: документация пользователя программного средства, код ОКС 35.080.

3. Наименование проекта в области стандартизации: проект национального стандарта Российской Федерации «Информационные технологии. Системная и программная инженерия. Стиль изложения документации пользователя программного средства. Общие требования».

4. Положения, отличающиеся от положений соответствующих международных аналогов: международных аналогов не имеет.

5. Срок публичного обсуждения: 2 (два) месяца.

6. Прием замечаний по проекту осуществляется по адресу: Россия, 117997, Москва, ул. Профсоюзная, д. 84/32 (для Философт). Телефон: +7 (495) 787-81-79. Факс: +7 (495) 333-62-78. Адрес электронной почты: standard@philosoft.ru.

7. Копию проекта документа в области стандартизации можно получить: Россия, 117997, Москва, ул. Профсоюзная, д. 84/32. Телефон: +7 (495) 787-81-79. Факс: +7 (495) 333-62-78. Адрес электронной почты: standard@philosoft.ru.

Дата публикации на сайте 30.10.2006