Документация на программное обеспечение (ПО)

Прежде чем говорить о документации на программный продукт, давайте попробуем сперва разобраться с официальной терминологией.

Итак, согласно официальной терминологии ГОСТ в технической документации приняты следующие термины:

1) Программное обеспечение – научная и практическая деятельность по созданию программ (ГОСТ 19.781-90).
2) Программа – данные, предназначенные для управления конкретными компонентами системы обработки информации в целях реализации определенного алгоритма (ГОСТ 19.781-90).
3) Программное средство – объект, состоящий из программ, процедур, правил, а также, если предусмотрено, сопутствующих им документации и данных, относящихся к функционированию системы обработки информации
(ГОСТ 28.806-90).
4) Программный комплекс – набор взаимодействующих программ, согласованных по функциям и форматам, имеющих единообразные и точно определенные интерфейсы, а также составляющих полное средство для решения больших задач.
5) Программное изделие – программа или логически связанная совокупность программ, записанная на носителе данных и являющаяся продуктом промышленного производства (ГОСТ 28.806-90).
6) Программный продукт – программное средство, предназначенное для поставки, передачи, продажи пользователю (ГОСТ 28.806-90).

Немного неожиданные определения, не так ли?

Но вернемся к вопросу разработки документации для программного обеспечения по ГОСТ. Возьмем, например, документ «Руководство пользователя» для какого-нибудь программного комплекса, представленного на коммерческом рынке. Данный документ можно отнести к следующим видам технической документации:

• документация на программу / программное обеспечение (в общем смысле);
• документация на программное средство (включает программы и документацию, является системой обработки информации);
• документация на программный продукт (коммерческий продукт, предназначенный для продажи);
• документация на программное изделие (на компакт-диске в красивой упаковке);
• документация на программный комплекс (комплекс по своей структуре);
• программная документация (вид документации по ГОСТ 19).

Теперь обратимся к самым передовым технологиям. Например, продукт Office 365, который компания Microsoft позиционирует как полноценное SaaS-решение (software as a service) и предлагает по подписке без установки на компьютер пользователя. Куда стоит отнести документацию на такие продукты?

Как видите, при разработке документации на программное обеспечение есть много нюансов: вы можете именовать документы различными способами – в некоторых случаях это будет верно, в некоторых возможны расхождения.

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