На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- Язык Джулии
- Технический писатель:
- софб
- Название проекта:
- Новое изобретение веб-сайта FluxML
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание проекта
Это предложение направлено на улучшение веб-сайта документации Flux, чтобы содержащаяся на нем информация была структурированной и привлекательной для новичков и экспертов. В частности, цель состоит в том, чтобы реорганизовать существующую документацию в новые разделы и создать новое руководство по началу работы для новичков, которое расширяет руководство Flux 60-mine-blitz.
Проект состоит из следующих этапов:
Проанализируйте текущий веб-сайт документации: проверьте существующую информацию и определите руководство по стилю (для информации) для создания новых руководств.
Определите новую структуру информации и руководство по началу работы: работайте с наставниками над определением новых разделов и реорганизацией веб-сайта документации. Кроме того, определите содержание руководства по началу работы, используя руководство Flux 60-mine-blitz в качестве отправной точки, и опирайтесь на него.
Реструктурируйте информацию: обновите веб-сайт согласно плану, определенному совместно с наставниками на предыдущем этапе.
Создайте руководство по началу работы: напишите первый черновик и просмотрите его. Получите обратную связь от наставников. Когда мы с наставниками определим, что у нас есть окончательная версия этого документа, я опубликую ее на веб-сайте документации.
(Необязательно) Преобразуйте существующую документацию в виде файлов README в HTML: если у меня останется некоторое время после завершения четырех основных этапов, я могу преобразовать существующие учебные пособия в виде файлов README, чтобы к ним было легче получить доступ с веб-сайта.
Для достижения цели проекта я буду тесно сотрудничать с сообществом Flux, чтобы понять существующую документацию и определить лучший подход. Я сам новичок в Julia и считаю, что это будет очень полезно для определения правильного уровня информации для нового руководства по началу работы.
Я сосредоточусь на том, чтобы моя работа помогла сообществу Flux найти новые способы использования. Кроме того, я сосредоточусь на том, чтобы помочь опытным пользователям открыть для себя новые варианты использования и изучить более мелкие детали Flux.