На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- Проект FreeBSD
- Технический писатель:
- кофеин
- Название проекта:
- Создайте главу справочника по винам
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание Проекта
В рамках этой инициативы я хотел бы написать подробную главу Руководства FreeBSD, посвященную установке, использованию и устранению неполадок WINE (www.winehq.org) во FreeBSD. Я бы старался уделять 4–8 часов каждую неделю работе над приведенными ниже пунктами, если не указано иное.
*** Связывание сообщества
Если бы меня выбрали, я бы посвятил период взаимодействия с сообществом ознакомлению с процессами документирования и инфраструктурой проекта FreeBSD. Меня всегда впечатляла связная документация, которую выпускал проект, и я общался с членами команды проекта по поводу их рабочего процесса. Я также присоединялся и просматривал форумы, ориентированные на пользователей, чтобы понять, что может помочь пользователям FreeBSD в отношении документации в целом и в работе с WINE во FreeBSD в частности.
В этот период я потратил некоторое время на изучение набора инструментов документации проекта. Это позволит мне сразу же приступить к делу в первые недели проекта, если меня выберут.
*** Неделя 1 (14–19 сентября): Тестовая установка и устранение неполадок.
Первую неделю этапа разработки документации я потратил на пробную установку WINE на текущую стабильную версию FreeBSD, а также на установку и запуск различных приложений Windows, от простых утилит до более сложных приложений. Этот подход я использовал в аналогичной статье о ReactOS для MakeUseOf (https://www.makeuseof.com/tag/reactos-open-source-windows-clone/), только я бы использовал время первой недели, чтобы изучить более широкий выбор программ.
По моему опыту, такая предварительная трата времени полезна для выявления (и устранения неполадок) общих проблем типа «подводных камней». Таким образом, я смогу иметь под рукой решения, когда придет время писать соответствующие разделы, или, по крайней мере, отправлять запросы на помощь по соответствующим каналам.
Цель недели: получить представление о главах установки и необходимую информацию о том, как устранить распространенные проблемы установки.
*** Неделя 2 (21–25 сентября): Документирование установки WINE
В течение второй недели я фактически набросал раздел(ы), иллюстрирующий установку WINE популярными методами, в том числе:
- Из исходного кода с использованием системы портов;
- Через бинарные пакеты с использованием основных репозиториев;
- Использование доступных менеджеров пакетов с графическим интерфейсом, если они доступны, и;
- Из альтернативных репозиториев, таких как FreshPorts (и почему пользователь может это сделать).
В этом разделе важно обсудить 32- и 64-битные и одновременные установки, чтобы подчеркнуть дополнительные шаги, которые требуются для запуска программ с разными архитектурами.
Цель недели: Доработанная черновая версия разделов, описывающих установку WINE на FreeBSD. Этот «отшлифованный черновик» должен включать в себя почти окончательный текст (ожидающий корректуры и отзывов) и заполнители для снимков экрана, если не сами снимки экрана.
*** Неделя 3 (28 сентября – 2 октября): Запуск вашей первой программы WINE на FreeBSD
После установки подсистемы WINE в следующем разделе будет подробно описана установка и выполнение некоторых начальных программ. Скорее всего, они будут сосредоточены на простых автономных утилитах, таких как Notepad++ с открытым исходным кодом. Цель состоит в том, чтобы позволить пользователям быстро загрузить приложение, установить его и увидеть, как оно работает, с минимальными усилиями.
Этот раздел важен для того, чтобы продемонстрировать пользователям, что некоторые/многие приложения Windows действительно могут работать на FreeBSD, что делает ее жизнеспособным выбором для повседневных вычислений.
Цель недели: определение небольшого количества программ, которые устанавливаются без проблем и (в основном) работают «из коробки», а также доработанная черновая версия раздела(ов), иллюстрирующая их установку.
*** Неделя 4 (5–9 октября): Обзор и концепции WINE
Конец предыдущего раздела намекает на необходимость некоторой настройки и настройки, чтобы заставить определенные приложения работать с WINE, и на этом этапе введение в подсистему WINE будет полезно для предоставления контекста. В этих разделах будет рассмотрено, что поставляется с системой WINE, как она взаимодействует с FreeBSD и где пользователь может начать изучать систему или устранять неполадки.
Важно отметить, что этот раздел не преследует цель дублировать существующие ресурсы, а представляет собой организованный обзор со ссылками на другие (легко усваиваемые) источники для получения дополнительной информации.
Цель недели: Доработанный черновой вариант раздела(ов), знакомящего пользователей с подсистемой WINE.
*** Неделя 5 (12–16 октября): Конфигурация WINE во FreeBSD.
В этих разделах будет более подробно рассмотрена фактическая конфигурация WINE, начиная с общих модификаций/настроек, специфичных для FreeBSD. Они также проиллюстрируют использование папок $WINEPREFIX, которые можно использовать для настройки среды WINE для конкретного приложения. Поскольку существуют ресурсы, которые подробно объясняют эту концепцию, в этом разделе будет представлено лишь умеренно подробное введение, прежде чем давать ссылки на них.
Цели недели: Доработанный черновой вариант раздела(ов), подробно описывающего, где, как и при каких обстоятельствах требуется глубокая настройка WINE.
*** Неделя 6 (19–23 октября): графический интерфейс WINE на FreeBSD.
Поскольку настройка WINE для запуска определенной программы может оказаться сложной и трудоемкой задачей, существуют вспомогательные инструменты, упрощающие этот процесс. В этом разделе(ах) будет представлен обзор установки и использования некоторых опций, существующих во FreeBSD, в том числе:
- ВИНЕКфг
- винные трюки
- играонбсд
- другие по мере доступности
Цель недели: предоставить отточенные черновые разделы с инструкциями по установке и использованию как можно большего количества наиболее популярных вспомогательных приложений GUI WINE.
*** Неделя 7 (26–30 октября): Часто задаваемые вопросы по WINE/FreeBSD (исследования)
Некоторую наиболее ценную информацию о сложных технических приложениях, таких как WINE, можно найти во взаимодействии между пользователями, пытающимися решить конкретные проблемы, и экспертами, дающими ответы. Пользователи сэкономят много времени, если некоторые из этих часто задаваемых вопросов, особенно те, которые, как известно, затрагивают пользователей FreeBSD, будут собраны в одном месте.
Эти разделы будут направлены именно на это, и я бы провел эту неделю, просто исследуя типы проблем, которые обычно возникают у пользователей FreeBSD с WINE, а также выискивая и (насколько это возможно) проверяя ответы. Это даст читателям этой главы Справочника гораздо больше шансов быстро решить ту или иную проблему.
Этот раздел(ы) также будет включать список ресурсов, где можно найти ответы, которых он не дал.
Цель недели: Отточенный черновой раздел(ы), содержащий наиболее распространенные проблемы WINE, с которыми сталкиваются пользователи FreeBSD или в целом, а также ссылки/заметки относительно их решений. Обратите внимание: хотя работа на этой неделе не имеет черновых результатов, она, вероятно, потребует больше времени для поиска и согласования общих проблем, а также поиска их решений. Я ожидаю потратить около 8-10 часов на это исследование.
*** Неделя 8 (2–6 декабря): Часто задаваемые вопросы по WINE/FreeBSD
Эта неделя будет посвящена обобщению исследований седьмой недели для создания раздела(ов) с часто задаваемыми вопросами/общими проблемами устранения неполадок (при необходимости со ссылками на решения).
Цель недели: Отполированный черновой вариант разделов, в которых перечислены часто задаваемые вопросы и часто возникающие проблемы, а также пошаговые инструкции по их решению.
*** Неделя 9 (9–13 ноября): Многопользовательское администрирование WINE.
В этом разделе(-ах) будут представлены рекомендации для администраторов, желающих развернуть WINE в многопользовательском сценарии. Он будет включать не только лучшие практики по совместному использованию самой подсистемы несколькими пользователями, но и в отношении приложений Windows, развернутых в WINE.
Цель недели: Отточенный черновой вариант раздела(ов), подробно описывающего рекомендации и лучшие практики для администраторов FreeBSD по развертыванию WINE и приложений на его основе для нескольких пользователей.
*** Неделя 10 (16–20 ноября): Приложения, отзывы и администрирование.
Хотя я буду стараться учитывать любые отзывы, полученные от наставников и других рецензентов на протяжении всего процесса разработки, на этой неделе у меня будет время для более обширной реорганизации/переписывания, если потребуется.
Кроме того, за это время я напишу все административные указания, необходимые для этой главы Руководства (вступительная часть, указатели и т. д.), а также подготовлю дополнительную литературу, связанную с WINE (например, использование версии WINE для Linux посредством двоичной совместимости, DOSBox для старых версий). игры/программы и т.п.).
Цель недели: Доработанный черновик всей главы Руководства, включая все остальные разделы.
*** Неделя 11 (23–27 ноября): Завершение главы руководства.
Я планирую посвятить эту предпоследнюю неделю корректуре всего текста, проверке изображений и тестированию различных выходных данных (HTML, PDF и т. д.) по мере необходимости. На этой неделе также будут доступны обновления в случае, если какое-либо из вышеперечисленных программ (от самой FreeBSD до WINE или ее помощников) обновится с момента его первоначальной написания.
Цель недели: окончательная версия главы Руководства, включая все необходимые обновления.
*** Неделя 12 (30.11–5.12): Завершение проекта.
По соглашению с наставниками проекта я проверял главу Руководства в системе контроля версий, составлял отчет по проекту и представлял проект как завершенный.