Skip to main content

Documentation workflow

Last updated: 21.08.2026

  1. Documents are written within our Nextcloud installation.
  2. They are stored as *.md files (md = markdown) in their respective directory
  3. Commenting can happen within the *.md file or via the forum
  4. All documents are committed to a GIT repository
  5. That repository is synced to our Docusaurus installation
  6. Docusaurus file generation happens when required

Governance documentation​

Governance documentation should follow the principle:

Open by default, private when necessary.

Significant governance decisions should be recorded in a short and understandable way.

A useful decision record includes:

  • date
  • decision
  • responsible person, project, Stewardship Area, or Circle
  • short reason for the decision
  • relevant advice or objections where useful
  • outcome
  • review date where the decision is experimental or temporary

Documentation should be proportional to the significance of the decision.

Routine, reversible, and low-risk operational decisions do not need extensive documentation.

Confidential information, personal data, Code of Conduct details, passwords, tokens, security information, and sensitive legal or financial details should not be placed in public documentation.