О технической документации (часть 2). Виды документации
Это цикл статей, посвященный разработке технической документации:
Введение >> Часть 1 >> Часть 2 >> Часть 3 >> Часть 4 >> Часть 5
Какие основные виды технической документации бывают?
В настоящее время представлено достаточно большое количество Интернет-ресурсов, предлагающих различные варианты классификации документации. Один из наиболее достоверных методов – отталкиваться от жизненного цикла программного продукта, чтобы каждый этап такого жизненного цикла сопровождался определенным набором документов. В этом случае любой документ можно отнести к одному из следующих видов технической документации: предпроектная, проектная и эксплуатационная.
Предпроектная
Разрабатывается в случае, когда еще только планируется создание программного обеспечения. К документам этой стадии относятся концепции, технические задания, технические требования и прочие документы, отвечающие за требования к свойствам и особенностям использования конечного программного продукта. Также к данной стадии могут относиться документы, содержащие результаты научно-исследовательских или опытно-конструкторских работ, технико-экономические обоснования и прочие документы, являющиеся отправной точкой при создании программного обеспечения (автоматизированной системы). Сюда также можно отнести и документы, разрабатываемые для тендерных процедур (всевозможные коммерческие и технические предложения).
Проектная
Разрабатывается в процессе создания программного обеспечения. К документам данной стадии можно отнести документы, содержащие описание решений, реализуемых на различных этапах проекта. Классическим примером проектного документа является пояснительная записка к эскизному/техническому проекту. Основное назначение проектных документов – обеспечить полное описание решений, достаточное для последующего сопровождения или модернизации программного обеспечения
(автоматизированной системы).
Эксплуатационная
Разрабатывается уже на готовое программное обеспечение. Примерами эксплуатационных документов являются руководство пользователя/администратора, технологические инструкции и прочие документы, содержимое которых описывает свойства и порядок использования разработанного программного обеспечения (автоматизированной системы).
Дополнительные виды технической документации
Также на любой стадии не обойтись без документов организационно-распорядительного характера (приказы, акты, протоколы и приложения к ним). Иногда в отдельный класс выделяют «корпоративные документы» – стандарты предприятия, должностные инструкции, описание бизнес-процессов компании и т. п. На наш взгляд, все это можно отнести к организационно-распорядительным документам.
Совет №2: Обращаясь за разработкой документации, в первую очередь необходимо определить, какой именно ее вид вам нужен сейчас – отталкивайтесь от текущего этапа разработки вашего программного обеспечения. При наличии свободного времени и желания вы можете попробовать самостоятельно разобраться со всеми видами, однако лучше всегда обратиться к профессионалам.