Вы здесь:

Доступность документации

Вопрос: Насколько легко пользователи и участники могут найти информацию, которую они ищут, в документации проекта?

Описание

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

Цели

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

Реализация

Использование и распространение показателей работоспособности может привести к нарушению конфиденциальности. Организации могут быть подвержены рискам. Эти риски могут проистекать из соблюдения GDPR в ЕС, законодательства штата в США или другого законодательства. Также могут быть контрактные риски, вытекающие из условий обслуживания для поставщиков данных, таких как GitHub и GitLab. Использование метрик должно быть проверено на предмет рисков и потенциальных проблем с этикой данных. Посмотри пожалуйста Документ по этике данных CHAOSS для дополнительных указаний.

Стратегии сбора данных

Участники опросного проекта:

Шкала Лайкерта [легко найти - невозможно найти] относительно возможности обнаружения документации, такой как:

  • Архивное сообщение списка рассылки
  • Управление членством в списке рассылки
  • Переписка в архиве канала чата
  • Выполнение проверки кода
  • Процесс принятия кода
  • Нормы поведения
  • Адаптация новичков
  • Лицензия, торговая марка
  • Руководство проектом
  • Релизы проекта
  • Процесс голосования

Флажок с множественным выбором: как найти проектную документацию?

  • Cайт
  • Хранилища
  • Документация в программе
  • Поисковая
  • Другое

Множественный выбор: Испытывали ли вы какие-либо проблемы, связанные с доступностью документации, когда вы начали участвовать в проекте (например, языковой барьер или структура документации)? Варианты ответа:

  • Нет проблем
  • Несколько проблем
  • Несколько проблем
  • Множество проблем

Открытый дополнительный вопрос, если ответ отличается от «Без проблем»:

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

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

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

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

Файлы для скачивания

Авторы

Последний раз этот показатель проверялся 24 июля 2022 г. в рамках процесса пересмотра показателей.

Теги:
Была ли эта статья полезна?
нелюбовь 0