Platform for team developer documentation

Acronym

service-doc-platform

Belongs to

SIG

Responsible

THMSR and Tobi

History

(v1)   2021-10-08 - created initially

(v2)   2021-10-17 - took task

(v3)   2021-11-05 - Adapt GitHub Wiki

Why is there need for such a decision?

We need to have a uniform way how to find developer documentation for a service, so that you don’t need to look in five different places if you walk through services.

Additional sources for better understanding the background

• n/a

Viable Options

• GitBook
• GitHub Pages
• GitHub Wiki

Alternatives not seriously considered

• Word
• Paper & Pen

How is this decision evaluated?

• Time to deployment (or in this case time to writing)
• User-friendliness

Resolution Details

• We use GitHub Wiki
  • Allows different formats

Reasons for the resolution

• GitBook is now more commercialized and does not provide an easy collectively-usable documentation
• GitHub Pages needs a longer training period and more effort than GitHub Wiki
• GitHub Pages is more flexible but adds complexity as a tradeoff