Просмотр кода страницы Общие требования к документации

В данной статье речь пойдет о документации. Любой. Проектной, продуктовой, регламентах, инструкциях, описаниях бизнес-архитектуры. 

== Документация должна быть: ==
* Актуальной
* Краткой
* Достаточной
* Адресной
* Понятной
* Доступной
* Красивой
Рассмотрим подробнее эти требования

== Актуальность ==
Нет смысла в документации, информация в которой устарела. Более того, такая документация наносит вред. Поэтому вся документация должна регулярно пересматриваться и актуализироваться при необходимости. Если вы считаете, что затраты на актуализацию какой-то документации неоправданны, значит она вам не нужна. Убирайте её вообще.

== Краткость ==
Документации должно быть столько сколько действительно нужно и не больше. Каждый лишний документ, каждая  лишняя буква в документации выливаются в минуты и часы впустую потраченного времени  сначала при разработке, согласовании, а потом и при пользовании.

== Достаточность ==
Но документации и не должно быть меньше чем нужно. Не мало систем "погибло" из-за отсутствия документации или из-за отсутствия в ней важной информации.

== Адресность ==
Любая документация должна разрабатываться с пониманием кто будет эту документацию читать. И надо четко осознавать, что документация для разных категорий потребителей должна отвечать именно на их вопросы. Нет смысла описывать пользователям системы тонкости финансирования её разработки, а экономистам детально описывать функции системы. Каждому свое.

== Понятность ==
Когда вы поняли для кого предназначена документация, не забудьте писать её на их языке, в тех терминах, которые будут понятны. Инструкции для обычных пользователей просто и понятно, для администраторов - точно и конкретно, ТЭО для менеджмента - на том уровне, который существует в компании.

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

== Красота ==
Как показывают исследования, визуальное восприятие документации, её качество и "красота" довольно сильно влияют на восприятие и запоминание её смысла.

Стандартизация формата оформления документации - это тоже часть понятия красоты.

Не стоит жалеть время на то, чтобы сделать документацию привлекательной, затраты времени на разработку окупятся повышением эффективности её использования.
[[Категория:Цифровизация]]