На этой странице представлена информация о проекте по написанию технических текстов, принятом для участия в конкурсе Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- Операционная система Qubes
- Технический писатель:
- лузил
- Название проекта:
- Вперёд, QubesOS! Давайте напишем открытое и простое в использовании руководство.
- Длительность проекта:
- Стандартная продолжительность (3 месяца)
Описание проекта
Включаем QubesOS!
Я хотел бы создать открытое руководство и сопутствующие материалы для начинающих пользователей QubesOS. Цель — познакомить неспециалистов с QubesOS и сделать руководство максимально кратким и понятным, используя аналогии, иллюстрации и диаграммы. Для краткости будут использоваться ссылки на надежные и проверенные ресурсы, в первую очередь на сайт QubesOS. Все материалы будут выпущены под открытой лицензией.
Под "автономным" контентом я подразумеваю материалы, которые могут существовать независимо от веб-сайта, например, в виде справочника. Это не равнозначно офлайн-версии руководства. В идеале, параллельно с веб-сайтом, должен быть создан отдельный канал для публикации контента в виде руководства.
Под "открытым" я подразумеваю руководство, которое будет выпущено под открытой лицензией.
Как это можно сделать
Определите целевую аудиторию
На сегодняшний день у меня сложилось впечатление, что целевая аудитория QubesOS недостаточно определена. Какую пользу QubesOS может принести журналистам, юристам, аналитикам безопасности, разработчикам программного обеспечения и так далее? Было бы полезно описать сценарии, в которых QubesOS может оказаться полезным.
Правильно выстраивайте ожидания.
Также важно предупредить начинающих пользователей, что QubesOS требует определенного уровня знаний в области информационных технологий. Использование QubesOS сопряжено с определенными затратами с точки зрения удобства, особенно если QubesOS является вашей основной вычислительной системой. В то же время, есть вещи, которые QubeSOS делает плохо (по замыслу разработчиков), например, 3D-ускорение в виртуальных машинах. Важно четко обозначить это с самого начала, не для того, чтобы отпугнуть людей от использования, а чтобы создать предпосылки для потенциальных пользователей.
Что такое QubesOS и чем QubesOS не является
Несмотря на то, что QubesOS — это операционная система особого типа (дистрибутив Xen), было бы интересно сравнить её с другими операционными системами по их функциональности или её отсутствию (например, Windows всё чаще использует виртуализацию и песочницу в качестве механизмов безопасности). Можно было бы использовать простую диаграмму/таблицу.
Технические характеристики руководства будут определены совместно с сообществом.
Каков минимальный объем информации, который должно содержать руководство? Насколько можно упростить установку без ущерба для безопасности? Где должен находиться пороговый уровень? Существует ли минимально жизнеспособная и безопасная конфигурация QubesOS? Если нет, ее можно определить и установить в качестве целевого показателя для руководства.
Лицензия
Выберите лицензию. На уважаемой вики Archlinux используется лицензия GNU Free Documentation License 1.3 или более поздняя версия. Подойдет ли вам эта лицензия?
Другие начинания
Сделайте документацию на сайте более привлекательной с визуальной точки зрения.
Примечания можно выделить красным или желтым цветом, чтобы их было легче заметить. Например, можно использовать цветные рамки, подобные тем, что есть в вики Arch Linux: https://wiki.archlinux.org/index.php/Linux_Containers.
Можно использовать блочные цитаты.
Ссылка на содержимое
В настоящее время на сайте документации довольно много контента, но отдельные разделы часто не связаны с другими релевантными темами. Для улучшения доступности можно было бы добавить ссылки между статьями.