[SIG Services][Guideline] User facing documentation/admin documentation - Githubissues

open-services-group / community

This repository handles a few common things, it is mainly used by our bots...

GNU General Public License v3.0

8 stars 24 forks source link

[SIG Services][Guideline] User facing documentation/admin documentation #222

Closed Shreyanand closed 2 years ago

Shreyanand commented 2 years ago

Documentation

User documentation:

how to access the service
how to get started: basic use case of the service
how to configure the service with an example configuration
link to the support process
link to privacy policy, rbac policy, terms and conditions, SLAs
complete list of features available to the user
Define a central location for the user documentation (avoid multiple places)
Easy to find and easy to understand
Updated with new releases or more often if needed

Admin documentation

Development doc :- environment, and how to contribute
Define basic troubleshooting knowledge that can be used by the operators of the service
How to interact with the users (e.g. admin view of the support process)

Borrow from and point to how to write good documentation for open source projects. Focus on elements that are specific to a service.

mimotej commented 2 years ago

/assign