- Пишите комментарии о записи, а не о себе. Вы можете писать о | Shut up and write

- Пишите комментарии о записи, а не о себе. Вы можете писать о себе, если это имеет отношение к делу. Когда пишите о себе, то пишите от первого лица единственного числа. Опустите слова вроде “я думаю” и “по-моему".

Когда судья впервые прочитал главу о хранимых процедурах, он был совершенно сбит с толку, пока не прочитал раздел 4. Подумайте о том, чтобы перенести этот материал во введение.
Когда я впервые прочитал главу о хранимых процедурах, я был совершенно сбит с толку, пока не прочитал раздел 4. Подумайте о том, чтобы перенести этот материал во введение.

Я думаю, что рисунок на стр. 17 дает прекрасный обзор всего производственного процесса.
Рисунок на стр. 17 дает прекрасный обзор всего производственного процесса.

- Формулируйте комментарии как предложения, а не приказы. Например, начните предложение со слов “рассмотрите ...” и “подумайте…”. Добавьте обоснование ваших предложений.

Вы должны использовать меньше шрифтов.
Большой выбор шрифтов затрудняет чтение документа. рассуждения … Подумайте о том, чтобы использовать меньше шрифтов.

Всегда используйте нумерованные списки в процедурах.
Рассмотрите возможность использования нумерованного списка вместо маркеров для шагов установки на стр. 6. Если вы не хотите использовать нумерованный список для процедурных шагов, таких как длинный список задач на стр. 16, рассмотрите возможность добавления флажков. Пользователи могут распечатать PDF-файл и отметить каждый шаг. В качестве альтернативы можно озаглавить раздел “Обзор задач настройки”, чтобы читатели не задавались вопросом, почему шаги не имеют цифр.

- Конечно, весь фидбек нужно писать без ошибок, в активном залоге, все как с документацией.