[Cubicweb] [Documentation] Organisation (or re-organisation?)

Arthur Lutz arthur.lutz at logilab.fr
Fri Mar 8 09:54:45 CET 2019


I came across this blog post about documentation
https://www.divio.com/blog/documentation/

the TLDR version is : there should be 4 types of documentation for a
project :

* Tutorials (learning oriented)

* How to guides (problem oriented)

* Reference (information oriented)

* Explanation (understanding-oriented)

I think the CubicWeb has some (or most) of these sections. Would it be
beneficial to look at re-organising the documentation with this approach
in mind ?

Arthur



More information about the Cubicweb mailing list