Documentation Guidelines
Your style, your words, and your tone define you. Correspondingly, this style guide lays out standard editorial instructions that define Shopware documentation.
We recommend that every contributor follows the defined writing standards to maintain uniformity of the documentation. Refer to different sections of this guide to know more.
Audience
It is important to consider the background of the potential audience reading your writing. This helps you to adapt your writing to meet their needs and interests.
| Who is the audience? | What are their roles? |
|---|---|
| Fullstack developer |
|
| Frontend developer |
|
| Backend developer |
|
| API developer |
|
| DevOps |
|
| Project/ Solution architect |
|
| Designer |
|
| Product owner/ Manager |
|
| Tech writers |
|
Applicable documents: style guide coverage
Word list
Choose ecommerce and technical terms from the pre-defined list of terminologies:
INFO
These are internal resources visible to Shopware employees only.
Use of third-party sources
Third-party sources include websites, books, blogs, videos, images, and more. Ensure to reference these external sources in the documentation only if they are trustworthy. Avoid copying any content directly from other sources like websites, encyclopedias, and Wikipedia.
Markdown rules
Adhere to the Markdown cheat sheet while creating the document.
Refer to Vitepress syntax for features like hint block, emoji, API blocks, etc.
Symbols in Markdown sometimes serve multi-purpose. For example, * or - can be used to create bulleted lists. However, follow a single pattern to maintain uniformity throughout. Further sections describe the usage of these patterns and let us comply with them.
Also, user-defined rules govern the content quality, such as removing trailing spaces, code fence style, and more. You may refer to these rules in the Markdown style of Shopware docs.
The following section details the conceptual outline structure of our documentation.
