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