658 B
658 B
Documentation Guidelines
Language
The primary documentation language is German.
An English version will be maintained as a translation of the German master document.
UI terminology
All user interface terms remain in English.
Examples:
- Direct Calculation
- Extrapolation
- Roll Diameter
- Product Length
- Capacity Summary
- Capacity Analysis
- Governing Constraint
Do not translate UI labels.
Style
- Technical user manual
- Workflow-oriented
- Explain why, not only how
- Engineering language
- No marketing language
Workflow
- Write German chapter.
- Technical review.
- Add screenshots.
- Approve.
- Translate to English.