Требования к отчёту: как сделать его читаемым
Отчёт пишут не для себя, а для человека, который видит исследование впервые. Если ему приходится переспрашивать базовые вещи, документ не выполняет свою задачу.
Ниже — как сделать отчёт читаемым, не упрощая содержание.
Определите читателя
Читатель может быть проверяющим, коллегой из другой области или участником команды. Их вопросы различаются, и структура отчёта зависит от того, кто будет читать первым.
Обычно ориентируются на самого требовательного из ожидаемых читателей.
Если отчёт читают разные группы, помогает короткая вводная фраза о том, какие разделы важны для каждой из них. Это не удлиняет текст заметно, но избавляет от жалоб на избыточность и недостаток деталей одновременно.
Первый экран
Первая страница отвечает на вопросы: что исследовали, как, что получили, какие ограничения. Если этого нет, читатель идёт искать по тексту и теряет контекст. Первый экран отчёта работает как выбор ноутбука под задачу: читатель сразу видит, подходит ли ему документ.
Резюме и оглавление решают эту задачу.
Если отчёт длиннее десяти страниц, помогает краткое оглавление с номерами страниц. Читатель находит нужный раздел без прокрутки и не пропускает важные ограничения, которые обычно стоят в конце.
Термины
Термины объясняют при первом употреблении или выносят в глоссарий. Одинаковые понятия называют одинаково по всему тексту.
Синонимы в отчёте создают ощущение разных сущностей.
Глоссарий удобно составлять по ходу работы: каждое новое понятие сразу попадает в список. В конце остаётся только упорядочить его по алфавиту и убрать повторы.
Структура
Разделы идут в логическом порядке: цель, методы, результаты, обсуждение, ограничения, приложения. Заголовки формулируют так, чтобы по оглавлению было понятно содержание.
Пустых разделов и заголовков «Разное» быть не должно.
Нумерация разделов облегчает ссылки: в обсуждении можно сослаться на раздел методов, и читатель найдёт его без поиска. Ссылки на таблицы и приложения работают так же.
Формулировки
Пишут короткими предложениями, без канцелярских оборотов. Утверждения делают проверяемыми: с числом, периодом или ссылкой.
Оценочные слова заменяют описанием.
Проверка простая: если предложение можно понять двумя способами, его переписывают. Двусмысленность в методах и результатах дороже, чем в обсуждении, поэтому начинают с них.
Таблицы и рисунки
Таблицы читаются без текста, рисунки имеют подписи. Ссылки на них идут в тексте до самого объекта, чтобы читатель знал, зачем смотреть.
Лишние таблицы убирают.
Объём
Отчёт не должен быть длиннее, чем нужно для ответов на вопросы протокола. Подробности выносят в приложения.
Длинный текст без структуры читается хуже короткого.
Сокращение полезно проводить по разделам: если раздел не отвечает ни на один вопрос протокола, его либо переносят в приложение, либо убирают. Такой подход уменьшает текст без потери содержания.
Если текст сокращают, сначала убирают повторы, затем детали, не влияющие на понимание, и только потом приложения. Удаление приложений чаще вредит, чем помогает: именно там лежат доказательства.
Ответы на ожидаемые вопросы
Полезно заранее перечислить вопросы, которые зададут читатели, и ответить на них в тексте или в приложении. Это экономит переписку.
Частые вопросы обычно касаются данных, методов и расхождений.
Список вопросов полезно вести с начала работы: вопросы коллег и проверяющих повторяются. К концу исследования набирается готовый раздел, который экономит время всем.
Проверка читателем
Попросите человека вне проекта прочитать отчёт и отметить, где он застрял. Каждое место переписывают или дополняют.
Один такой проход меняет текст сильнее, чем вычитка автором.
Читателя просят не исправлять текст, а отмечать места, где он остановился. Так видно, что именно требует переработки, и автор не получает сотню стилистических правок вместо содержательных.
Оформление
Единый шрифт, нумерация страниц, оглавление, единые отступы. Оформление не должно отвлекать: его задача — не мешать.
Ссылки и сноски проверяют перед сдачей.
Проверяют, что таблицы не разрываются между страницами и заголовки не остаются в конце страницы без текста. Эти мелочи заметны при чтении и создают ощущение небрежности.
Версии
На титуле указывают версию и дату, а изменения перечисляют кратко. Читатель должен понимать, что перед ним: черновик или итог.
История версий хранится вместе с отчётом.
Версия на титуле должна совпадать с версией в описи файлов. Расхождение — частая причина того, что обсуждают один документ, а проверяют другой.
Если отчёт отправляют нескольким адресатам, полезно вести список получателей с датой отправки. При вопросах сразу видно, у кого какая версия, и не приходится гадать, что именно читал каждый.
Пример: непонятное сокращение
В отчёте многократно используется аббревиатура, расшифрованная только в приложении. Читатель без контекста тратит время на поиск.
Расшифровка при первом употреблении решает проблему за одну строку.
Правило простое: аббревиатура расшифровывается при первом употреблении в основном тексте, даже если она есть в глоссарии. Читатель, открывший документ с середины, тоже должен понимать текст.
Чек-лист
- Понятно, для кого отчёт.
- Первая страница даёт общую картину.
- Термины объяснены.
- Структура логична.
- Формулировки проверяемы.
- Таблицы читаются отдельно.
- Объём оправдан.
- Текст прочитан человеком вне проекта.
Перед сдачей полезно прочитать отчёт вслух: места, где сбивается дыхание, обычно совпадают с перегруженными предложениями. Это быстрый способ улучшить читаемость без редактора.
Частые вопросы
Нужен ли глоссарий?
Если терминов много или читатель не из области — да.
Можно ли писать от первого лица?
Зависит от принятого стиля; главное — единообразие.
Как быть с техническими деталями?
Вынести в приложение и сослаться из основного текста.
Кто утверждает финальную версию?
Ответственный за отчёт, после проверки читателем.