Проект ОС Qubes

На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.

Краткое описание проекта

Организация с открытым исходным кодом:
ОС Qubes
Технический писатель:
c1e0
Название проекта:
Объединение руководств по устранению неполадок
Длина проекта:
Стандартная продолжительность (3 месяца)

Описание Проекта

АБСТРАКТНЫЙ

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

ТЕКУЩЕЕ СОСТОЯНИЕ РУКОВОДСТВА ПО УСТРАНЕНИЮ НЕИСПРАВНОСТЕЙ

На данный момент руководства по устранению неполадок QubesOS разбросаны по множеству страниц и иногда неполны, что приводит к многократному опубликованию одних и тех же инструкций, помогающих пользователям диагностировать проблемы. В доступных руководствах отсутствует схема действий «симптомы», что затрудняет пользователю сопоставление проблемы с ее решением. Кроме того, есть некоторые проблемы, которые неоднократно упоминались в социальных сетях (Reddit), на странице проблем Qubes Github и на форуме #qubes-users, но не были задокументированы в текущем руководстве по устранению неполадок.

ПОЧЕМУ ПРЕДЛАГАЕМОЕ МОЕ РУКОВОДСТВО ПО УСТРАНЕНИЮ НЕИСПРАВНОСТЕЙ ЯВЛЯЕТСЯ УЛУЧШЕНИЕМ ПО СВЯЗИ С ТЕКУЩИМ?

Предлагаемое мной руководство по устранению неполадок будет полным и структурированным, чтобы обеспечить точность и удобную навигацию. В руководстве будут представлены краткие инструкции, которые шаг за шагом объясняют, как решить проблему. В нем будет представлена ​​схема «симптомы-действия», в которой будет изложена проблема, а затем рекомендовано решение этой проблемы. Устранение неполадок будет оптимизировано для поисковых систем и сформулировано с учетом того, какие проблемы пользователи ищут в социальных сетях и поисковых системах. Все это будет сделано для того, чтобы пользователи могли найти официальное руководство по устранению неполадок через поисковые системы и быстро/легко найти решение своих проблем.

СТРУКТУРА ПРЕДЛАГАЕМОГО РУКОВОДСТВА ПО УСТРАНЕНИЮ НЕИСПРАВНОСТЕЙ И СРОКИ

Я создал предлагаемую структуру руководства по устранению неполадок ОС Qubes, которое можно найти здесь: https://docs.google.com/document/d/187NlnEvctYVVUnRuGtwY2PkYBVxBSSPfpSwZEaczqL8/edit?usp=sharing. Макет сопровождается примерным сроком, в течение которого будет написан каждый раздел устранения неполадок. Этот макет будет реализован после обратной связи с наставником. Структура и сроки могут быть изменены с учетом отзывов наставников.

ЦЕЛИ ПРОЕКТА

  • Измените структуру руководства по устранению неполадок, чтобы оно имело более понятную и консолидированную структуру симптомов и действий.
  • Перепишите существующие инструкции по устранению неполадок, чтобы получить простые пошаговые инструкции.
  • При необходимости добавьте скриншоты
  • Установите и опробуйте Qubes самостоятельно и запишите все возникшие проблемы. У меня три компьютера: Lenovo Thinkpad, Dell Latitude и Acer Aspire. Я попробую Qubes на каждом из этих компьютеров, запишу все ошибки и проверю возможные способы устранения неполадок.
  • Удалите всю устаревшую информацию из существующего руководства.
  • Убедитесь, что способы устранения неполадок точны. На данный момент в существующих руководствах по устранению неполадок имеется сообщение об ошибке «Это неофициальная сторонняя документация». Проект Qubes OS не может гарантировать точность этой страницы. Пожалуйста, соблюдайте осторожность"". Это предупреждение будет удалено после проверки точности инструкций по устранению неполадок. Их точность будет обеспечиваться либо личным тестированием устранения неполадок на моих компьютерах (если возможно), либо проверкой в ​​Интернете, подтвердили ли какие-либо пользователи решение.
  • Перенесите все внешние способы устранения неполадок (с форума и GitHub) на официальную веб-страницу устранения неполадок.
  • Изучите и найдите больше проблем, с которыми сталкиваются пользователи Reddit (r/QubesOS), Stack Exchange, группы #qubes-users Google и проблем GitHub. Я также буду использовать инструменты исследования ключевых слов, такие как Keywordtool.io и UberSuggest.com, чтобы узнать, какие вопросы часто задаются в поисковых системах, таких как Google.
  • Добавьте раздел «Получение помощи», если руководство по устранению неполадок не решит проблему пользователей. Пример можно увидеть на странице устранения неполадок Fedora: https://docs.fedoraproject.org/en-US/fedora/rawhide/install-guide/install/Troubleshooting/#sect-troubleshooting-getting-help.

ПОЧЕМУ ЭТОТ ПРОЕКТ?

Я увлечен технологиями, особенно кибербезопасностью и конфиденциальностью. Я считаю, что писательство — одна из моих сильных сторон. Меня особенно интересует ОС Qubes, поскольку она пересекает два моих основных интереса: безопасность и конфиденциальность. Я заядлый пользователь других продуктов, ориентированных на безопасность и конфиденциальность, таких как DuckDuckGo и Tor. Я только недавно открыл для себя Qubes OS, и до сих пор она мне нравится.

ПОЧЕМУ Я ВЕРЮ, ЧТО Я ПОДХОДЯЩИЙ ЧЕЛОВЕК ДЛЯ ЭТОГО ПРОЕКТА

  • Я увлечен безопасностью, конфиденциальностью и написанием хорошей и полезной документации.
  • Поскольку у меня возникли проблемы при установке и использовании ОС Qubes, я смогу лучше представить эти проблемы в инструкциях по устранению неполадок.
  • В прошлом месяце я изучал технические аспекты операционной системы Qubes. Я также тщательно изучил документацию по ОС Qubes. Чтобы получить представление о процессе редактирования документации, я создал запрос на включение (https://github.com/QubesOS/qubes-doc/pull/1005/files).
  • Недавно я прошел стажировку в проекте Tor. Моими обязанностями были техническая поддержка и написание статей. Работая в службе поддержки, я получил сотни вопросов от пользователей, сталкивавшихся с проблемами при установке или использовании Tor Browser. Помогая этим пользователям устранять их проблемы, я научился писать краткие и понятные инструкции по устранению неполадок.
  • Работая над проектом Tor, я также писал техническую документацию, используя Markdown. Для контроля версий я использовал Git, GitHub и GitLab.