Contributing¶
The SMF documentation should be clear, reproducible and easy to review.
Basic rules¶
- Use descriptive headings.
- Keep pages focused on one topic.
- State units and process parameters.
- Document assumptions and deviations.
- Add references where appropriate.
- Link related processes and equipment.
- Do not publish passwords, personal data or confidential information.
- Safety-related changes require review.
Simple page structure¶
# Page title
## Purpose
Explain what the page describes.
## Description
Provide the necessary background information.
## Procedure
1. First step
2. Second step
3. Third step
## Results
Document observations or measurements.
## References
- Manual, paper or other source
## File names
Use lowercase file names with hyphens:
photolithography.md
spin-coater.md
pn-junction-process.md