40 lines
658 B
Markdown
40 lines
658 B
Markdown
# 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
|
|
|
|
1. Write German chapter.
|
|
2. Technical review.
|
|
3. Add screenshots.
|
|
4. Approve.
|
|
5. Translate to English.
|