Часто полезно группировать информацию в контексте, чтобы помочь людям выполнить сложную задачу, понять набор связанных задач или проиллюстрировать весь рабочий процесс. Используйте более длинные статьи, объединяющие типы контента, чтобы убедиться, что люди находят контекстное содержимое в нужном месте. Более длинные статьи также помогают исключить дублирование содержимого и подготовить содержимое для масштабирования по мере добавления дополнительных параметров в продукт. Люди чаще всего требуются более длинные статьи во время активного использования продукта, и им может потребоваться обратиться к статье в различных точках их пути.
Объединение нескольких типов контента в статье
- Используйте концептуальное, процедурное, референциальное, устранение неполадок или известное содержимое проблемы в более длинной статье, а также не используйте краткие руководства или руководства.
- Используйте разделы различных типов контента в статье по мере необходимости и следуйте рекомендациям по заголовку для типа контента.
- Чаще всего эти статьи будут содержать по крайней мере один процедурный раздел плюс хотя бы один дополнительный концептуальный, референтный или процедурный раздел.
- Используйте рекомендации по упорядочению содержимого для упорядочивания заголовков в статье.
- Используйте сведения об устранении неполадок как можно чаще.
- При необходимости можно реплика указать название статьи в заголовке.
Рекомендации по заголовку статей, которые объединяют несколько типов контента
- Если в статье есть процедура, используйте название на основе задач, начинающееся с герунда.
- Заголовки достаточно общие, чтобы описать диапазон информации и задач, содержащихся в статье.
- Заголовки описывают параметр, который переключается и не зависит от того, какой параметр выбирает читатель, например "Настройка видимости репозитория" вместо "Создание общедоступного частного репозитория".