- STAEDEAN documentation guidelines and processes
Documentation guidelines
If you write documentation for STAEDEAN products, apply some basic rules. Use these rules to improve the readability of your texts. If you apply these rules, also the uniformity of the documentation improves.
General documentation guidelines
If you write
technical documentation, apply some basic rules. Use these rules to improve the
readability of your texts. If everyone
applies these rules, also the uniformity of the documentation improves.
UI label guidelines
This section gives some basic guidelines to be applied to the UI labels:
- Use standard Microsoft Dynamics 365 for Finance and Supply Chain Management terminology
Follow the standard terminology. So, do not invent or introduce own terminology if for the subject already terminology is available.
- Use existing labels
Use existing labels as much as possible. So, first look if the label already exists in standard Microsoft Dynamics 365 for Finance and Supply Chain Management or in the solution label file.
- Use ‘full’ words
Always use ‘full’ words. So, do not use abbreviations or acronyms.
- Be as precise and specific as possible
Be as precise and specific as possible in your wording. Write exactly what you mean. Always think: will the user understand exactly what I try to say here? Will the user understand what this field or button is exactly used for?
- Check for typos
Always check for typos.
Note:
- These guidelines mainly apply to Microsoft Dynamics 365 for Finance and Supply Chain Management. However, where appropriate, you can also use them for Microsoft Dynamics 365 Business Central
- Also have a look at the guidelines in the General documentation guidelines section. The focus of those guidelines is on writing text in US English. However, a lot of those guidelines can also be applied to writing labels.
References
Several references are available where you can find more information and guidelines on writing documentation.
