Рецензирование — это процесс проверки документации, чтобы удостовериться, что она написана корректно. Иными словами, это процедура, ответственная за соблюдение правильности написания документации и соответствие документа специальным стандартам технического письма.
Поскольку создание проектной документации считается одной из важнейших составляющих рабочего процесса проекта, обеспечение ее качества имеет неоспоримое значение. Для этой цели компании всегда проводят первичную проверку документации, которая также называется процессом рецензирования. Давайте разберемся, что такое рецензирование и почему оно так важно.
Что такое процесс рецензирования?
Как было сказано, рецензирование отвечает за обеспечение качества документации. Однако оно отличается от обеспечения качества (QA), которое проверяет требования проекта и документацию. Основное отличие заключается в том, что процесс обеспечения качества, выполняемый командой QA, является гораздо более сложной процедурой, которая иногда требует много времени и ресурсов. Инженеры QA тестируют различные аспекты технической и не технической документации через глубокие исследования.
С другой стороны, процесс рецензирования требует меньше времени и ресурсов, так как проверяется только логика изложения и текстовое содержание документа. Таким образом, этот процесс прост и представляет собой только поверхностное тестирование. Несмотря на это, рецензирование документации имеет специальную процедуру и людей, ответственных за это.
Процесс рецензирования
Самое простое объяснение этого типа обеспечения качества заключается в том, что после написания части документа она сразу передается ответственному человеку, который читает ее и оставляет комментарии.
Это могут быть комментарии, объясняющие или редактирующие различные аспекты документации, от технической правильности до грамматики и пунктуации предложений.
Как правило, эту работу выполняет член команды — рецензент, который обладает специальными знаниями и образованием в области технического или писательского мастерства. Иногда обязанности рецензента могут быть возложены на руководителя команды или менеджера проекта, но это менее эффективно, так как у этих людей есть свои задачи.
После поверхностного тестирования рецензент вносит все необходимые комментарии или редактирует что-то самостоятельно; в конце концов, они отправляют статью обратно автору для исправлений. Иногда авторы могут проверить и обновить текст, но это тоже не очень эффективно с точки зрения разумного обеспечения качества.