DevOps Service Documentation Framework

Documentation is essential for the long-term maintenance of the service. But getting documentation right is not an easy task.

What should be documented? Where should the documentation reside? Who should maintain the documentation? How to make sure it is not outdated?

Answer any of those questions wrong and the efforts spent on the documentation will be wasted at best. In the worst case they can even lead to business damages.

Service360 proposes a simple devops service documentation framework which will allow you not only to answer those questions once and for all, but also promotes learning team and organization wide.

You can find DevOps Service Documentation Framework in S360 documentation section.

Features

• Standardized documentation layout:
  • all services have predictable documentation layout easing service support and onboarding/handover
• Promotion of the service maintenance best practices:
  • Essential documentation is governed by the risks. If something is missing - risk will be raised
• Guarantees on the documentation correctness in the long run:
  • Periodical Service Audit enforces documentation reviews.

Questions answered

• What should be documented?
• Where can I find service maintenance documentation?
• Can I trust this documentation?
• Who maintains service documentation?