docs: complete user manual v1.0 (without screenshots)
This commit is contained in:
@@ -0,0 +1,39 @@
|
|||||||
|
# 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.
|
||||||
+1744
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user