Виды документации в IT. Как хранить документацию

Документация в IT имеет свою специфику. Это может быть техническое задание от клиента или тестовая документация специалиста по тестированию продукта. Или же пользовательская документация.

Виды документации

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

1. Инструкция по применению
2. Мануал
3. Трабл шутинг гайд (Trouble shooting guide)
4. Release Notes
5. Read me

• Тестовая документация включает в себя методики, планы, сценарии и результаты испытаний.
• Документация по безопасности описывает способы защиты информации и управления рисками, в том числе рекомендации по обеспечению защищенности, стандарты, процедуры, политики и др.
• Обучающие и информационные материалы предоставляют ценные сведения всем заинтересованным сторонам.

Способы хранить документацию.

Прошли те времена, когда объемные руководства пользователей печатались на принтере. И даже хранение их в Word и PDF уже не предпочтительно. Крайне желательно, чтобы к документации имели доступ сразу все те люди, которые имеют отношение к разработке продукта. Так команде будет удобно вносить правки.

Сегодня IT компании предпочитают хранить документацию по продукту в

Git

GitHUB

Confluence

Jira

Notion