На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- Командный чат Zulip с открытым исходным кодом
- Технический писатель:
- Дрроса
- Название проекта:
- Рефакторинг ReadTheDocs и документации API
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание Проекта
Я сосредоточусь на двух направлениях и буду работать над ними параллельно. Один из них — улучшить качество zulip.readthedocs.io , чтобы у новых участников возникало меньше путаницы и сомнений на этом пути. В идеале результатом будет четкий и краткий путь от первого вклада до ознакомления с тем, как работает Zulip. Я также планирую поработать над zulipchat.com/api , api.md и openapi.md , чтобы облегчить понимание процесса документирования дополнительных конечных точек. Обе части, скорее всего, будут включать обновление/упрощение контента, наведение порядка в статьях, добавление недостающей документации для разработчиков, а также написание/тестирование кода.
Проект будет состоять из четырех этапов. Первый этап будет включать небольшие ознакомительные проекты, подготовительные инструменты и лучшее понимание текущих потребностей в документации. Целью второго этапа будет структурирование, конкретизация и определение приоритетов работы в контексте целей Зулипа на этот осенний сезон. Затем я перейду к этапу реализации проекта. Я буду обращаться к наставникам и остальным членам сообщества разработчиков Zulip за отзывами. Заключительный этап — оглянуться назад, внести изменения, где это необходимо, и написать отчет о проекте.
Я подозреваю, что некоторые приоритеты и задачи могут измениться в течение периода работы в результате того, над чем работают все остальные; включая решения, принятые основными разработчиками. Я ожидаю, что умение хорошо адаптироваться к таким изменениям станет необходимым аспектом успешного опыта GSoD. Возможно, в какой-то момент имеет смысл отложить предложенные идеи на потом. Вообще говоря, я сосредоточусь на том, чтобы моя работа приносила пользу общему успеху проекта Zulip с открытым исходным кодом.