На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- Плон
- Технический писатель:
- Крис
- Название проекта:
- Улучшение документации для интерфейса Volto на основе React.
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание проекта
Volto — это новый интерфейс для систем управления веб-контентом, основанный на реагировании. Развитый REST API соединяет Volto со всеми функциями Plone, одной из самых безопасных, надежных и гибких систем управления контентом за последние 15 лет.
Во время сезона документации Google мы стремимся упростить и открыть документацию Volto для гораздо более широкой аудитории разработчиков. Поскольку текущая документация сосредоточена на фактической информации, мы планируем улучшить общее качество контента путем расширения и перепроектирования контента для удовлетворения различных потребностей разработчиков.
Людям, знакомым с React, нужна информация о том, как получить доступ к функциям Plone, чтобы они могли создавать многофункциональные веб-сайты с усовершенствованными рабочими процессами и разрешениями, а также наслаждаться надежным хранилищем и поисковой системой в фоновом режиме. Разработчики, уже знакомые с Plone, захотят использовать новейшие инструменты JavaScript для создания более современных сайтов.
Учитывая разнообразие глобальных сообществ Plone и Volto, мы будем уделять особое внимание тому, чтобы избегать культурных, гендерных или других предубеждений, создавая тем самым инклюзивную и доступную документацию для самого широкого круга разработчиков. Ясный, последовательный и краткий язык также помогает многим разработчикам Plone и Volto, для которых английский не является первым или даже вторым языком.