Description
Setup a diataxis based ocm documentation guideline.
This guideline is supposed to serve as framework to quickly answer which category of documentation (how to, tutorial, explanation, reference) (for which version of ocm) has to be written in which situation (such as a particular code change).
In other words, WHEN to write WHAT kind of documentation and WHERE to put it.
This is a spike as it includes research about diataxis.
Timebox: 1 day(s)
Done Criteria
Description
Setup a diataxis based ocm documentation guideline.
This guideline is supposed to serve as framework to quickly answer which category of documentation (how to, tutorial, explanation, reference) (for which version of ocm) has to be written in which situation (such as a particular code change).
In other words, WHEN to write WHAT kind of documentation and WHERE to put it.
This is a spike as it includes research about diataxis.
Timebox: 1 day(s)
Done Criteria