Documentation guidelines

Figure 963. Documentation content Slide presentation

  • Technical background

  • Related links

    • Standards

    • Reference documents

  • Installation / configuration procedures

  • Problems, critical steps


Figure 964. Technical features Slide presentation

  • Content as Html (No Pdf, Word & friends)

  • Chunked by topics

  • Navigation, cross references, link stability

  • Optional: Full text search

  • Optional: Integrated CI/CD version control pipeline



Prev  Up  Next
Manual server management  Home  Hetzner cloud administration GUI