Процедурное содержимое помогает пользователям выполнять задачу с начала до конца, пока они используют GitHub.
Мы создадим процедурные статьи и процедурные разделы в более крупных статьях.
Написание процедурных статей
Шаблон процедурного содержимого см. в разделе Шаблоны.
- Следуйте рекомендациям по стилю для процедурных действий в Руководство по стилю.
- Процедурное содержимое может получить повторяющееся — искать возможности группировать связанное содержимое в одну длинную статью.
- Сгруппировать несколько связанных процедур в одну статью, если не существует причин.
- Если при отключении параметра или отмене задачи требуются те же действия и не имеют особых последствий, не создавайте отдельную процедуру.
- Если при отключении параметра или отмене задачи требуются различные шаги или имеются важные или специальные последствия, создайте длинную статью, чтобы содержать обе процедуры. Используйте неустранимый заголовок.
- Расскажите читателям ожидаемый результат процедуры.
- Добавьте советы по устранению неполадок как можно чаще.
Названия процедурного содержимого
- Процедурные статьи или процедурные разделы в статьях основаны на задачах и начинаются с герунда.
- Использование: "Применение к пакету разработчика для учащихся"
- При необходимости используйте активные и определенные команды (мозговой штурм или используйте тезаурус).
- Заголовки специально описывают задачу, содержащуюся в статье или заголовке, но достаточно общие, чтобы отразить все содержимое.
- Длина заголовка статьи: максимум 80 символов, 60, если это возможно.