О принципах проектирования содержимого %% variables.product.prodname_dotcom %}
Мы создадим документацию по продукту, которая помогает, учит и привлекает всех, кто использует GitHub. Одним из этапов этой работы является проектирование содержимого, которое мы пишем. Мы следуйте этим принципам при разработке и планировании содержимого.
- Наше содержимое — это центрирование пользователей и инклюзивность. Мы уважаем всех, кто посещает документы и делает контент, который работает для них с нашей стратегией, дизайном и выбором стиля.
- Наше содержимое объясняет, почему наши продукты полезны и помогают людям достичь своих целей и приоритетов.
- Мы тратим наши ресурсы на создание высококачественной, ценной документации для сообщества GitHub.
- Мы создадим достаточно документов - больше содержимого делает все труднее найти, и все добавленное разбавляет все остальное (GitHub Zen).
- Мы итерируем и итерацию, чтобы узнать больше из опыта, отраслевых знаний и работы с нашим сообществом GitHub Docs мы корректируем наши процессы, методики и рекомендации.
Мы предоставляем руководство по стилю и con режим палатки ls в качестве стандартных блоков и рекомендаций для всех пользователей для разработки и создания документации.
- Руководство по стилю и con режим палатки ls применяются к различным сценариям.
- Решения основаны на том, что лучше всего подходит для людей, использующих наши документы, а не просто то, что правильно или неправильно в соответствии с грамматикой или правилами стиля. Мы гибки и открыты для изменения при сохранении согласованности.
- Мы сосредоточим внимание на документе с высоким уровнем влияния, высокоценных сценариев, а не на попытке комплексного покрытия всех возможных вариантов использования для многих продуктов и функций GitHub.
- Наши самые высокие приоритеты — ясность, смысл, правильность и согласованность.
- При принятии решения о стиле или структуре мы рассмотрим, что люди пытаются сделать с информацией и как наше содержимое может лучше поддержать свои цели.
- Если вопрос, характерный для документации, не охватывается руководством по стилю или con режим палатки l, мы оцениваем его с помощью этих принципов, а затем принять решение.