Описание
Краткое объяснение того, как раздел «Описание» помогает структурировать чтение технического справочника и какие сведения обычно в него входят.
Назначение раздела
Раздел «Описание» в техническом справочнике служит вступительной частью, где назван предмет и обозначена его область применения. Читатель получает общее представление о назначении инструмента до того, как переходит к параметрам, синтаксису или примерам. Такой порядок снижает число вопросов на этапе первого знакомства с документацией.
Что обычно содержит описание
Типовое описание фиксирует, какую задачу решает функция или модуль, какие типы данных она принимает и возвращает, а также к какой тематической группе относится. Здесь же указывают ограничения, например поддерживаемые кодировки или разрядность. Конкретные идентификаторы и контракты приводятся только при наличии подтверждённого источника.