Files
OpenParcelBox/docs/constraints.md
T

622 B

Documentation Constraints

Language

  • Main project documentation must be written in English.
  • Additional translations may be added later if needed.

Durability

  • Documentation must be versioned with the project.
  • Only open formats should be used.

Reproducibility

  • Every manufacturing step must be documented.
  • Every installation step must be documented.

Illustrations

  • Prefer vector diagrams when possible.
  • Photos must be archived in the repository when they are required for reproduction or validation.

Open Source

  • No proprietary document should be required to reproduce the project.