Проект командного чата с открытым исходным кодом Zulip
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- Командный чат Zulip с открытым исходным кодом
- Технический писатель:
- Дрроса
- Название проекта:
- Рефакторинг ReadTheDocs и документации API
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание проекта
Я сосредоточусь на двух направлениях и буду работать над ними параллельно. Один из них — улучшить качество zulip.readthedocs.io , чтобы у новых участников возникало меньше путаницы и сомнений на этом пути. В идеале результатом будет четкий и краткий путь от первого вклада до ознакомления с тем, как работает Zulip. Я также планирую поработать над zulipchat.com/api , api.md и openapi.md , чтобы облегчить понимание процесса документирования дополнительных конечных точек. Обе части, скорее всего, будут включать обновление/упрощение контента, наведение порядка в статьях, добавление недостающей документации для разработчиков, а также написание/тестирование кода.
Проект будет состоять из четырех этапов. Первый этап будет включать небольшие ознакомительные проекты, подготовительные инструменты и лучшее понимание текущих потребностей в документации. Целью второго этапа будет структурирование, конкретизация и определение приоритетов работы в контексте целей Зулипа на этот осенний сезон. Затем я перейду к этапу реализации проекта. Я буду обращаться к наставникам и остальным членам сообщества разработчиков Zulip за отзывами. Заключительный этап — оглянуться назад, внести изменения, где это необходимо, и написать отчет о проекте.
Я подозреваю, что некоторые приоритеты и задачи могут измениться в течение периода работы в результате того, над чем работают все остальные; включая решения, принятые основными разработчиками. Я ожидаю, что умение хорошо адаптироваться к таким изменениям станет необходимым аспектом успешного опыта GSoD. Возможно, в какой-то момент имеет смысл отложить предложенные идеи на потом. Вообще говоря, я сосредоточусь на том, чтобы моя работа приносила пользу общему успеху проекта Zulip с открытым исходным кодом.
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0". Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2024-11-19 UTC.
[[["Прост для понимания","easyToUnderstand","thumb-up"],["Помог мне решить мою проблему","solvedMyProblem","thumb-up"],["Другое","otherUp","thumb-up"]],[["Отсутствует нужная мне информация","missingTheInformationINeed","thumb-down"],["Слишком сложен/слишком много шагов","tooComplicatedTooManySteps","thumb-down"],["Устарел","outOfDate","thumb-down"],["Проблема с переводом текста","translationIssue","thumb-down"],["Проблемы образцов/кода","samplesCodeIssue","thumb-down"],["Другое","otherDown","thumb-down"]],["Последнее обновление: 2024-11-19 UTC."],[[["This project aims to improve the Zulip developer documentation for easier contribution and understanding."],["The focus is on refining ReadTheDocs for new contributors and enhancing API documentation for easier endpoint documentation."],["The project will involve restructuring, simplifying, and adding content, along with code writing and testing."],["The project is divided into four phases, starting with familiarization and ending with a final report, with continuous feedback and adaptation."],["The project's success is measured by its contribution to the overall success of the Zulip open-source project."]]],["The project focuses on improving Zulip's documentation for contributors and developers. Key actions include enhancing the clarity and conciseness of `zulip.readthedocs.io`, and improving the ease of documenting API endpoints on `zulipchat.com/api`, `api.md`, and `openapi.md`. The work will involve updating content, decluttering articles, adding missing information, and testing code. The project will unfold in four phases: familiarization, structuring/prioritization, implementation, and revision/reporting, with ongoing feedback from the Zulip community. The project will be adaptable to potential changes in priorities.\n"]]
