Концептуальное содержимое помогает людям понять функцию или раздел, предоставляя четкий, высокоуровневый обзор, объяснение того, как функция или раздел могут помочь им в их пути, а также контекст, например варианты использования или примеры.
Мы создаём концептуальные статьи и концептуальные разделы в других статьях. Большинство основных товаров, материалов или тем имеют собственные концептуальные статьи.
Выбор между статьёй и разделом
Инструкции или обучающие материалы могут содержать 1-2 кратких вводных предложений перед этапами. Если требуется дополнительное объяснение, выходящее за рамки нескольких предложений, тогда стоит задуматься, заслуживает ли это места в концептуальной статье.
Однако мы должны быть избирательными. Не каждая концепция или раздел «О X» нуждается в отдельной статье. В целом это сводится к тому, сколько информации будет полезно пользователю, которую нужно включить.
Как написать концептуальное содержимое
Общие сведения о шаблоне содержимого см. в разделе Шаблоны.
- Описать на простом языке то, что такое функция, продукт или раздел.
- Описать ее цель и почему это полезно для читателя.
- Совместное использование вариантов или примеров.
Заголовки для концептуального содержимого
Короткие заголовки статей должны состоять из одного слова или существительного. Если статьи размещены в разделе «Понятия» в боковой панели, избегайте использования «О нас», если только статья не находится под заголовком с тем же названием. Например: «Кодирующий агент» и «О кодирующем агенте».
Заголовки концептуальных разделов в статьях начинаются с «О [теме]».
- Используйте существительное для описания темы.
- Использование: «О code scanningместе»
- Избегайте: "О проверке кода на наличие уязвимостей"
Примеры концептуального содержимого
- Статьи с описанием концепций
- Концептуальные разделы в других статьях
- Сведения о политиках безопасности в Добавление политики безопасности в репозиторий
- "О режиме обслуживания" в Включение и планирование режима обслуживания