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