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