Нужно ли объяснять, что написано в следующих главах?

Нужно ли при написании технического отчета объяснять, что написано в последующих главах?

Например, в моей вводной главе у меня может быть подраздел под названием «Предстоящие главы», в котором объясняется, что будет обсуждаться в каждой следующей главе. Что-то вроде «В главе «Мои методы» будут объясняться методы моих исследований...»

Я видел примеры, когда люди делали это, но мне все кажется «очевидным» в отношении того, что должна содержать глава о методах.

Улучшает ли это техничность, красноречие или профессионализм доклада?

Ответы (1)

Во-первых, если в вашем учреждении есть руководство по стилю, следуйте его рекомендациям, если таковые имеются. Но если об этом молчит или у вас его нет:

Полезно предоставить схему остальной части отчета. Если у вас уже есть оглавление, этого может быть достаточно (я видел ТУ с содержанием и без него). Тем не менее, если вы включите что-то в конце введения, избегайте проблемы «отдел резервного отдела».

Плохо: «Глава 2, Методы, объясняет методы моего исследования». Вы не сказали ничего, что уже не подразумевалось заголовком.

Лучше: «Глава 2, Методы, объясняет, как мы использовали (что-то) метод для (чего-то)». Ключевым моментом здесь является добавление чего-то к «методам»: назовите метод, расскажите что-нибудь о важных факторах для этого метода, если это уместно («провел испытание с 4 группами в течение 12 месяцев»), или иным образом расскажите людям что- нибудь о нем. ваши методы прямо в резюме. Это позволяет читателю, который уже знает, что такое (что-то) метод, перейти прямо к результатам, если он хочет, не задаваясь вопросом, верны ли они вообще. (Конечно, заинтересованный читатель может вернуться и прочитать ваши методы позже.)

Таким образом, в более широком смысле смысл раздела «вот что находится в остальной части этого документа» состоит в том, чтобы предоставить короткие подсказки, достаточно содержательные, чтобы люди могли бегло просмотреть и перейти к частям, которые их больше всего интересуют.

Наконец, размер этой короткой подсказки может несколько увеличиваться в зависимости от размера документа. Если ваш ТЗ состоит из 5 глав на 30 страницах, вероятно, подойдет одно предложение на каждую. Но если это 5 глав на 300 страницах, вам может быть полезно немного углубиться и написать по абзацу или около того для каждой. Думайте о них как о мини-аннотациях к каждой главе. Как и в случае с рефератом, вопрос читателя, на который вы пытаетесь ответить, звучит так: «Хочу ли я это прочитать?».