Каждый автор стремится создать идеальный текст, но даже самые внимательные из нас допускают ошибки. И это нормально!

Для минимизации ошибок технические писатели проводят Peer Review. PR — это дополнительная вычитка текста перед публикацией.

Как это в теории: вычитка и оценка документа. Как это на самом деле: выясняются дополнительные детали, публикация документа затягивается.

Чтобы не было «как обычно 🙄», попробуйте следующее:

• Возьмите минимум 3-х человек на PR (технический писатель, человек от сервиса/продукта и «потенциальный пользователь»)
• Подключите Linter для автоматической проверки документации
  • например, markdownlint в VS Code для проверки на соответствие правилам разметки Markdown
• Прислушивайтесь ко всем комментариям, даже если они кажутся вам плохими