Проект Фонда OpenJS

На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.

Краткое описание проекта

Организация с открытым исходным кодом:

Фонд OpenJS

Технический писатель:

Свет

Название проекта:

Переработанная документация Fastify

Длина проекта:

Стандартная продолжительность (3 месяца)

Описание проекта

Мое внимание будет сосредоточено на двух областях. Одним из них является создание руководства по стилю, которое также включает в себя реструктуризацию текущей документации в fastify.io, что упрощает работу новых пользователей. Другой будет улучшать качество содержимого вкладов в Fastify, чтобы у новых участников было меньше путаницы и сомнений на этом пути. В идеале результатом будет четкий и краткий путь от первого вклада до ознакомления с тем, как работает Fastify.

Этот проект пройдет следующие 4 этапа. Сначала необходимо ознакомиться с доступными комплексными инструментами и лучше понять текущие потребности в документации. Целью второго этапа будет структурирование, определение и придание приоритета контексту целей Fastify для этого GSoD. Затем начните этап реализации, который включает в себя общение с наставниками и сообществом разработчиков Fastify для получения обратной связи. Последним шагом будет рассмотрение и исправление, где это необходимо, и написание отчета по проекту.

Я постараюсь внести вклад в общий успех этого проекта с открытым исходным кодом.