Note
This guide is for Plone 6 and JavaScript related documentation.
For Plone 5, please follow our guide on docs.plone.org.
Introduction
Key Point
💡 Use this guide as style reference for our documentation.
This guide aims to improve our documentation, by improving consistency and readability.
The guide is a reference document; instead of reading through it in linear order, you can use it to look up specific issues as needed.
Markdown guide
Markdown is a lightweight markup language with plain text formatting syntax.
The Plone community uses CommonMark, a defined, highly compatible specification of Markdown.
Editorial guide
Aim, to write friendly, and respectful without being overly colloquial or frivolous. A voice that's casual and natural and approachable, not pedantic or pushy.
Be understandable, uncomplicated and crisp.
Don't try to write exactly the way you speak; you probably speak more colloquially and verbosely than you should write.
Aim for a conversational tone rather than a formal one.
Be human, let your personality show, be memorable; you can even be a little funny now and then.
Please remember that the primary purpose of the document is to provide information to someone who's looking for it.