На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- LibreOffice
- Технический писатель:
- кофеин
- Название проекта:
- Онлайн-руководство по LibreOffice: руководство, аналогичное тем, которые используются для других приложений LO, и включает не только использование, но также установку и администрирование.
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание Проекта
Если меня выберут, я планирую тратить от восьми до десяти часов в неделю как на написание нового контента, так и на изменение и перепрофилирование существующего контента руководства для создания руководства LibreOffice Online (LOOL). При той скорости, с которой я обычно пишу и посвящаю этому от восьми до десяти часов в неделю, я рассчитываю создать Руководство объемом примерно в 200 страниц или более.
Я использую эти приложения с тех пор, как они назывались StarOffice, и хорошо разбираюсь в расширенных функциях версий для настольных компьютеров, включая:
- Стили во всех приложениях
- Основные документы, перекрестные ссылки, рисунки и концепции настольных издательских систем в Writer
- Диаграммы, графики и инструменты анализа данных в Calc
- Интерактивные функции презентации, такие как переходы и анимация в Impress.
Я широко использовал эти настольные версии как на работе, так и в свободное время.
Я бы ориентировался на пользователей среднего технического уровня, поскольку это, скорее всего, люди, обладающие навыками, терпением и, что наиболее важно, интересом к запуску и запуску чего-то вроде LOOL. С точки зрения справочника, он, конечно, будет содержать прямое учебное содержание (например, как выделить жирным шрифтом выделенный текст), но необходимо предположить понимание некоторых технических концепций (например, что веб-сервер отвечает за обслуживание приложения). в браузер).
Что касается планирования, то с самого начала я бы подошел к проекту в соответствии со следующим графиком, подробно описанным ниже. Примечание: порядок, в котором я буду писать главы, не обязательно подразумевает их расположение в окончательной версии Руководства.
Неделя 1. Начало изучения инструкций по установке, тестирование различных методов установки, изучение приложений.
Цель этой недели — установить работающую установку LOOL. По моему опыту, обнаружение всех множества мелких «попался!» моментов документирования приложений такого типа требует затрат времени. На этой неделе я постараюсь проработать их до такой степени, чтобы я мог легко установить приложение любым доступным способом, не зацикливаясь на этих препятствиях.
Неделя 2. Выполнение эталонной установки, документирование методов установки
Эта неделя будет потрачена на составление приблизительного списка инструкций по установке (не в полностью написанном формате, а скорее «в цифрах»), а также ряда примечаний, которые будут включены в последующие главы.
Неделя 3: Напишите предисловие к главе(ам) — предисловие, введение, об этом руководстве и т. д.
Цель этой недели — подготовить одну или несколько полных, отточенных глав, содержащих всю необходимую информацию, необходимую читателю перед тем, как приступить к фактической установке.
Неделя 4: Написание глав по установке, часть 1
Цель этой недели — полные, отточенные инструкции по установке для некоторых доступных методов в стандартном формате глав руководства LibreOffice, но в такой форме, чтобы их можно было легко переназначить, например, для вики.
Неделя 5: Написание глав по установке, часть 2
Цель этой недели — полные, отточенные инструкции по установке остальных методов в стандартном формате глав руководства LibreOffice, но в такой форме, чтобы их можно было легко использовать повторно, например, для вики.
Неделя 6: Написание главы о настройке после установки
Цель этой недели — полные, отточенные главы по настройке после установки, такие как настройка предпочтений для приложения (например, часовой пояс), настройка пользователей и другие приготовления, которые администратор должен выполнить перед запуском системы в эксплуатацию.
Неделя 7: Написание глав о навигации, интерфейсе и управлении файлами.
Целью этой недели станут полные, отточенные главы, которые после прочтения сделают читатель знакомым и удобным для работы с пользовательским интерфейсом.
Неделя 8: Написание глав (текстовый редактор)
На этой неделе мы должны увидеть полные, отточенные главы, позволяющие пользователю создавать красиво оформленные документы прямо в приложении.
Неделя 9: Написание глав (глав) Calc (электронной таблицы)
Цель этой недели — завершить, доработать главы, позволяющие пользователю создавать функциональные таблицы, включая выбор поддерживаемых формул и диаграмм/графиков.
Неделя 10: Write Impress (презентация), главы
Целью этой недели будет создание законченных, отточенных глав, позволяющих пользователю создать интерактивную презентацию с возможностью вывода ее для использования в автономном режиме, а также для презентации в реальном времени.
Неделя 11: Написание глав по интеграции
Цель 11-й недели — полные, отточенные главы, предоставляющие пользователю полную картину доступных вариантов интеграции. Конкретное руководство по интеграции приложений, скорее всего, будет в форме ссылок на соответствующие ресурсы, такие как вики-страницы Document Foundation и/или интегрированные проекты.
Неделя 12: Соберите разные элементы (приложения, индексы, таблицы с цифрами и т. д.), 1-й этап редактирования/корректировки
К концу этой недели должно появиться полное Руководство с почти окончательным содержанием и неповрежденными/работающими элементами, такими как перекрестные ссылки.
Неделя 13: 2-й этап редактирования/корректуры, проверка набора текста/макета, отправка
На этой последней неделе будет представлено полное и окончательное Руководство, отредактированное как по содержанию, так и по представлению.