Оглавление (TOC) — это навигационный элемент, используемый в различных видах письменных работ: от технической документации до книг. Оно включает список основных глав и заголовков, страниц, разделов, подразделов и т. д. Трудно представить техническую документацию (инструкцию, руководство, отчет) без оглавления. В печатных оглавлениях указаны номера страниц, на которых начинаются главы, в то время как цифровое оглавление предоставляет ссылки на каждую тему.
Каково назначение оглавления в документации?
Оглавление предоставляет читателям информацию о том, где можно найти соответствующий контент. Оно размещается в самом начале документа и показывает, как темы или главы связаны между собой. В случае онлайн-документации главы, указанные в оглавлении, взаимосвязаны и переводят читателей к интересующему их контенту. Оглавление ускоряет работу с документацией. Например, вам не нужно читать весь отчет — достаточно найти раздел, посвященный интересующей вас теме.
Основные требования для создания оглавления
Оглавление необходимо оформлять в соответствии с определенными правилами. Во-первых, стиль и шрифт оглавления должны соответствовать стилю всего документа. Так как оглавление включает заголовки всех уровней, было бы полезно выделить основные части, чтобы они были заметны и их легко было найти. Оглавление должно отвечать потребностям читателей, помогая им ориентироваться и быстро находить нужную информацию. Поэтому важно учитывать, как именно читатели предпочитают работать с вашей документацией и как они ориентируются в ней.
Примеры оглавлений
Яркие примеры оглавлений можно найти в любой книге, печатной или электронной. Почти все виды технической документации содержат оглавление.