Странный вопрос. Основная функция документации - объяснять что-то. Что именно - зависит от типа документации. Если документация не выполняет свою задачу, то есть после прочтения остаются вопросы, то тест не пройден.
Человеку, проверяющему этот факт, думаю, полезно ориентироваться на следующие вопросы:
- Зачем? Документация должна иметь четкую цель, чтобы читающий сразу понимал, зачем эта документация. Это как бы очевидно, но автор плохой документации может упустить этот момент.
- Почему? Каждый пункт документации должен объяснять, почему выбрано именно такое решение, а не другое. Это сравнение с другими вариантами.
- Есть ли польза? Документация должна давать понять, что станет лучше по сравнению с тем, что уже имеется. Если там будет доказательство, что фича принесет деньги, это вообще шик.
Простой
