This page contains the details of a technical writing project accepted for Google Season of Docs.
Project summary
- Open source organization:
- Plone
- Technical writer:
- Cris
- Project name:
- Improve Documentation For The React-based Frontend "Volto"
- Project length:
- Standard length (3 months)
Project description
Volto is a new, react-based front end for web content management systems. A mature REST API connects Volto to all the features of Plone, one of the most secure, reliable, and flexible content management systems in the last 15 years.
During the Google Season of Docs, we aim to streamline and open up the Volto documentation to a much broader developer audience. Since the current documentation focuses on factual information, we plan to improve the overall content experience by extending and re-architecting the content to cater to various developer experiences.
People familiar with React need information on how to access the features of Plone so they can create feature-rich websites with refined workflows and permissions, and enjoy the rock-solid storage and search engine in the background. Developers already familiar with Plone will want to leverage the latest JavaScript tools to create more modern sites.
Considering the diverse, global Plone and Volto communities, we will pay particular attention to avoiding cultural, gender or other biases, thus creating inclusive and accessible documentation for the widest range of developers. Clear, consistent, and concise language also helps the many Plone and Volto developers for whom English is not their first, or even second, language.