Guiding principles

Jump to bottom

Mariana Bellorín Aguilera edited this page Feb 1, 2024 · 2 revisions

Plain language.
Simplicity.
Logical hierarchy and flow.
Content.
Link to other documentation/use cases/blog posts.
Easy to translate.
Keep in mind the documentation structure.
Lead text - this should be one or two paragraphs long.
General context.
What is this product or feature? How does it work?

The Diátaxis framework explains in detail our guiding principles.

For members of the Product Education team, check the Technical Writing Playbook for more details on tools and processes.