Идеальный процесс проверки документации


процесс проверки документов

Идеальной проверки документов не существует, но стремиться следует к такому процессу:

1) Автор проверяет документацию на полноту описания в соответствии с требованиями технического задания на систему.

2) Разработчик(и) проверяет документацию на полноту описания разработанных функций. Разработчик смотрит только сам факт наличия описания по каждой функции и больше ничего. Таким образом, на задачу ему потребуется 5-10 минут в зависимости от количества разработанных и описанных функций.

3) Тестировщик(и) проверяет документацию на актуальность. Тестирует документацию на применимость и удобство использования.

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

5) Любой сотрудник (лучше всего из отдела продаж), имеющий отношение к работе с системой, проверяет документацию на предмет удобства чтения: понятно ли написано, хорошо ли организован текст (структура документа), легко ли читается текст. При проверке учитывает последние пожелания или замечания заказчика к документации.