Доступность документации
Вопрос: Насколько легко пользователи и участники могут найти информацию, которую они ищут, в документации проекта?
Описание
Возможность обнаружения документации имеет решающее значение из-за той роли, которую она играет в инклюзивности проекта с открытым исходным кодом. Если люди не могут найти, а затем легко ориентироваться в массиве документации или найти ответы, которые они ищут, они с меньшей вероятностью будут использовать или вносить свой вклад в проект, что снижает способность проекта привлекать разнообразный набор участников. Возможность обнаружения документации имеет своей целью обеспечить возможность поиска и видимость, а также улучшить инклюзивность для разнообразной аудитории.
Цели
Метрика «Обнаружение документации» предназначена для поддержки документации:
- Наглядность: документацию легко найти и сослаться на нее.
- Возможность поиска: пользователи могут легко перемещаться по документации в зависимости от своих способностей, и они могут найти необходимую информацию с помощью поиска.
- Метод обнаружения: определение способов, которыми люди находят документацию.
- Инклюзивность: знания распределяются между участниками проекта более справедливо, и новым участникам легче участвовать.
Реализация
Стратегии сбора данных
Участники опросного проекта:
Шкала Лайкерта [легко найти - невозможно найти] относительно возможности обнаружения документации, такой как:
- Архивное сообщение списка рассылки
- Управление членством в списке рассылки
- Переписка в архиве канала чата
- Выполнение проверки кода
- Процесс принятия кода
- Нормы поведения
- Адаптация новичков
- Лицензия, торговая марка
- Руководство проектом
- Релизы проекта
- Процесс голосования
Флажок с множественным выбором: как найти проектную документацию?
- Вебсайт
- Хранилища
- Документация в программе
- Поисковая
- Другие контрактные услуги
Множественный выбор: Испытывали ли вы какие-либо проблемы, связанные с доступностью документации, когда вы начали участвовать в проекте (например, языковой барьер или структура документации)? Варианты ответа:
- Нет проблем
- Несколько проблем
- Несколько проблем
- Множество проблем
Полезные ресурсы
Чтобы изменить этот показатель, отправьте запрос на изменение здесь: https://github.com/chaoss/wg-dei/blob/main/focus-areas/project-and-community/documentation-discoverability.md
Чтобы ссылаться на этот показатель в программном обеспечении или публикациях, используйте этот стабильный URL-адрес: https://chaoss.community/?p=3534
Использование и распространение показателей работоспособности может привести к нарушению конфиденциальности. Организации могут быть подвержены рискам. Эти риски могут проистекать из соблюдения GDPR в ЕС, законодательства штата в США или других законов. Также могут быть контрактные риски, вытекающие из условий обслуживания для поставщиков данных, таких как GitHub и GitLab. Использование метрик должно быть проверено на предмет рисков и потенциальных проблем с этикой данных. Посмотри пожалуйста Документ по этике данных CHAOSS для дополнительных указаний.