Кодексы поведения на GitHub Enterprise Cloud Docs: правила и рекомендации

Кодексы поведения на GitHub Enterprise Cloud Docs – это набор правил и рекомендаций, разработанных для облегчения взаимодействия пользователей на платформе GitHub Enterprise Cloud Docs. Эти кодексы устанавливают основы коммуникации и сотрудничества, помогая создать толерантное, уважительное и продуктивное сообщество.

GitHub Enterprise Cloud Docs ценит и приветствует разнообразие перспектив и опыта, и поэтому справедливое, инклюзивное и безопасное пространство для обсуждения и работы является нашим приоритетом. Кодексы поведения помогают нам достичь этих целей, устанавливая стандарты и ожидания, с которыми должны соглашаться все пользователи.

Кодексы поведения на GitHub Enterprise Cloud Docs охватывают широкий спектр аспектов взаимодействия, включая основные правила коммуникации, этические принципы, подходы к обращению с разногласиями и иными вопросами, связанными с поведением на платформе. Мы призываем всех пользователей GitHub Enterprise Cloud Docs ознакомиться с этими кодексами и придерживаться их в своей работе и диалогах с другими участниками сообщества.

Стандарты поведения на GitHub Enterprise Cloud Docs

Соблюдение этих стандартов поведения позволяет нам создавать высококачественную документацию, способствовать развитию команды и улучшать опыт пользователей GitHub Enterprise Cloud Docs.

Кодекс этики

Принципы, регламентируемые кодексом этики, включают:

• Уважение к другим участникам сообщества, независимо от их пола, расы, этнического происхождения, религиозных убеждений, возраста, инвалидности или сексуальной ориентации.
• Отсутствие дискриминации, оскорбительного поведения, троллинга, буллинга или любой формы насилия.
• Поддержка и поощрение включительности и разнообразия в сообществе.
• Соблюдение авторских прав и правил использования открытых лицензий при использовании кода и других материалов.
• Соблюдение принципов конфиденциальности и защиты данных, особенно при работе с личными и чувствительными данными.
• Уважение правил и руководящих принципов каждого проекта и их вкладчиков.

Кодекс этики является обязательным для всех участников сообщества GitHub Enterprise Cloud Docs и нарушение его положений может привести к временным или постоянным ограничениям в использовании сервиса.

Все участники, наблюдающие нарушения кодекса этики, могут сообщить об этом администраторам сообщества или воспользоваться доступными инструментами для жалоб и обращений.

Отношения с сообществом

GitHub Enterprise Cloud Docs ценит своих пользователей и активное взаимодействие с сообществом. Мы стремимся создать дружественную и открытую среду, где каждый может делиться своими знаниями и опытом.

Мы признаем важность и ценность ваших вкладов и обратной связи. Если у вас есть предложения по улучшению документации, новые идеи или обнаруженные ошибки, пожалуйста, дайте нам знать через GitHub Issues. Мы очень рады вашему участию в развитии нашей документации.

Мы также активно сотрудничаем с сообществом, чтобы отвечать на ваши вопросы, предоставлять поддержку и решать проблемы. Вы можете обратиться к нашему сообществу через GitHub Discussions, где вы найдете не только ответы на часто задаваемые вопросы, но и дополнительные ресурсы и рекомендации от других пользователей.

Мы призываем всех участников нашего сообщества быть вежливыми и уважительными друг к другу. Мы приветствуем конструктивные обсуждения и споры, однако настоятельно рекомендуем избегать оскорблений, шумных и нецензурных выражений.

Если вы нашли нарушения Кодекса поведения со стороны других участников сообщества, пожалуйста, обратитесь к нам с описанием проблемы. Мы примем соответствующие меры для поддержания безопасной и дружественной атмосферы для всех участников.

• Уважайте права и мнения других участников.
• Будьте готовы помочь и поддержать других участников.
• Выбирайте уважительные и понятные формы общения.
• Избегайте спама, рекламы и ненужной саморекламы.

Мы надеемся на продолжение взаимовыгодного сотрудничества и благодарим вас за ваш вклад в наше сообщество!

Правила коммуникации

Взаимодействие в рамках GitHub Enterprise Cloud Docs строится на коммуникации с другими участниками. Чтобы обеспечить эффективное сотрудничество, соблюдайте следующие правила коммуникации:

1. Будьте вежливы и уважительны в общении.
2. Пишите четко и ясно, используя адекватный язык.
3. Ставьте себя на место других участников и пытайтесь понять их точку зрения.
4. Уважайте чужое мнение и будьте готовы к конструктивной критике.
5. Используйте теги и комментарии для отметки и обсуждения конкретных участков документации.
6. Модерируйте свой тон и избегайте оскорблений. Дискуссии должны быть конструктивными и способствовать решению проблем.
7. Уважайте приватность других участников и не раскрывайте или передавайте их персональные данные без их согласия.
8. Используйте инструменты коммуникации, предоставленные GitHub Enterprise Cloud Docs, для обсуждения и уточнения вопросов и задач.

Соблюдение этих правил поможет создать дружелюбную и продуктивную атмосферу работы на платформе и способствовать развитию проектов, размещенных в GitHub Enterprise Cloud Docs.

Взаимодействие с коллегами

- Будьте вежливыми и уважительными в коммуникации. Используйте позитивный тон и избегайте агрессивности.

- Будьте открытыми к обратной связи. Принимайте критику конструктивно и используйте ее для улучшения своей работы.

- Будьте готовыми помогать другим и делиться своими знаниями. Объясняйте сложные концепции и поддерживайте коллег в их проектах.

- Следите за обновлениями в репозиториях коллег. Оставляйте комментарии к их коду и предлагайте улучшения.

- Помните о конфиденциальности. Уважайте права коллег и не распространяйте информацию без их согласия.

Следуя этим рекомендациям, вы сможете создать продуктивную и приятную атмосферу сотрудничества на GitHub Enterprise Cloud Docs.

Правила работы с документацией

При работе с документацией на платформе GitHub Enterprise Cloud Docs важно соблюдать определенные правила, чтобы обеспечить ее качество и удобство использования для пользователей.

1. Документация должна быть четкой и понятной. Используйте ясные и лаконичные формулировки, избегая сложных терминов и лишних деталей.

2. Разделите документацию на логические части и обозначьте их заголовками. Это поможет пользователям быстрее находить необходимую информацию.

3. Помните о целевой аудитории. Опишите предполагаемые знания и навыки пользователей, чтобы адаптировать информацию под их нужды.

4. Используйте актуальные версии и ссылки на релевантные ресурсы для обновления информации при необходимости.

5. Проверьте текст на грамматические и орфографические ошибки. Опечатки и неправильная пунктуация могут затруднить понимание документации.

6. Предоставьте дополнительные ресурсы, такие как примеры кода, графики или ссылки на другие руководства, чтобы помочь пользователям лучше понять представленную информацию.

7. Будьте аккуратны при изменении или удалении информации. Перед внесением изменений важно обсудить их с командой и убедиться, что они не повредят работу других разработчиков.

8. Обратной связью и рекомендациями могут быть полезными для улучшения документации. Принимайте комментарии от пользователей во внимание и вносите соответствующие изменения.

Соблюдение этих правил поможет создать высококачественную и понятную документацию, которая будет полезна для всех пользователей GitHub Enterprise Cloud Docs.

Оформление и структура документов

Документация на GitHub Enterprise Cloud Docs оформлена и структурирована с целью максимального комфорта для пользователей и удобства в поиске информации. В этом разделе мы рассмотрим основные принципы оформления и структурирования документов.

Оформление документов включает в себя использование понятного и легко читаемого шрифта, четкого разделения на абзацы, заголовки разных уровней для обозначения разделов и подразделов.

Структура документов обычно организована в виде списка разделов, подразделов и пунктов. Каждый раздел должен иметь заголовок, который четко отражает содержание раздела.

Для удобства пользователей, особенно при наличии большого объема информации, рекомендуется добавлять ссылки для навигации между разделами и подразделами документации. Также полезно использовать разное форматирование текста, такое как жирный или курсивный шрифт, для выделения ключевых и важных моментов.

Чтобы упростить поиск информации в документации, рекомендуется использовать таблицы со списком ключевых терминов, определений и ссылками на соответствующие разделы.

Наличие навигационных элементов, таких как оглавление и ссылки на предыдущие и следующие разделы, позволяет пользователям легко перемещаться по документации и быстро найти нужную информацию.

Важно помнить о доступности документации для всех пользователей. Для этого необходимо использовать альтернативный текст для изображений, описывать таблицы и графики, а также предоставлять варианты скачивания документов в различных форматах.

При соблюдении этих принципов оформления и структурирования документов, пользователи смогут легко и быстро найти необходимую информацию, что повысит их удовлетворенность использованием GitHub Enterprise Cloud Docs.

Контроль качества и редактирование

1. Ответственность за редактирование

Каждый участник команды, работающей над кодексами поведения, должен быть ответственным за свою часть работы. Он должен следить за актуализацией информации, исправлять опечатки, устаревшие ссылки и другие ошибки. Также важно быть готовым принять и обработать отзывы и предложения от других членов команды.

2. Стиль и форматирование

При редактировании кодексов поведения следует придерживаться единого стиля и форматирования. Это позволит улучшить читабельность и упростить проверку изменений. Рекомендуется использовать одинаковое форматирование текста, использовать списки (

,
,
1. ) для перечислений и отделять блоки кода от обычного текста.

   3. Правописание и грамматика

   Опечатки, грамматические ошибки и плохой стиль являются причиной недоверия со стороны пользователей. Проверка правописания и грамматики является важной частью контроля качества кодексов поведения. Важно использовать правильные пунктуацию, написание слов и фраз, чтобы обеспечить понимание и удобство использования.

   4. Проверка изменений

   Перед тем, как делать pull request с изменениями в кодексы поведения, рекомендуется провести тщательную проверку своих изменений. Это позволит обнаружить и исправить ошибки до того, как они попадут в основную ветку проекта. Проверку следует проводить несколько раз, обращая особое внимание на стиль, форматирование, правописание и грамматику.

   Соблюдение принципов контроля качества и редактирования кодексов поведения способствует улучшению совместной работы команды и созданию более удобного и понятного руководства. Используйте эти рекомендации в работе над кодексами поведения на GitHub Enterprise Cloud Docs, чтобы обеспечить высокое качество и доступность информации.