Сведения о основах документации GitHub
Эти основы необходимы для документации GitHub . Используйте приведенные ниже списки, чтобы убедиться, что ваши вклады являются точными, доступными и инклюзивными и согласованными.
точными;
Документация правильна и точную.
- Убедитесь, что содержимое свободно от фактических ошибок.
- Убедитесь, что содержимое свободно от ошибок орфографии и форматирования.
Доступные и включаемые
Документация обновлена с последними стандартами специальных возможностей и написана, чтобы быть инклюзивной и понятной для перевода.
- Убедитесь, что содержимое соответствует рекомендациям по специальным возможностям и снимкам экрана. Дополнительные сведения см. в разделе Создание снимков экрана.
- Убедитесь, что содержимое можно успешно преобразовать. Дополнительные сведения см. в разделе Написание содержимого для перевода.
Постоянно
Документация поддерживает согласованный голос, тон и стиль на протяжении всего, создавая единый интерфейс для читателей.
- Убедитесь, что содержимое соответствует руководству по стилю GitHub Docs. Дополнительные сведения см. в разделе Руководство по стилю.
- Применение согласованных терминов и соглашений об именовании.
- Используйте элементы фирменной символики (например, названия продуктов и признаков, логотипы, цветовые схемы) в содержимом.