Contents: Description Organize by purpose Organize by Audience other ideas Notes Examples

Summary

improve documentation by organizing it into the 4 kinds

Owner

Tim

Reporter

Tim

Status

open

Priority

medium

Version

1.5

Subsystem

doc

Tags

doc

Description [edit section]

Our current wiki documentation is somewhat scattered and unorganized.

Organize by purpose [edit section]

Organize it better by putting into the 4 kinds of documentation that are recommended by https://documentation.divio.com/

• Tutorials
• How-to guides
• Explanations
• Reference

Organize by Audience [edit section]

Maybe also separate docs by audience:

• Fuego user
• Fuego developer

Note that a Fuego user should be a 'test developer', so there might be 3 audiences:

• Fuego test user
• Fuego test developer
• Fuego system developer

other ideas [edit section]

Some random ideas:

• Allow editing docs by editing rst directly on bitbucket

Notes [edit section]

Examples [edit section]

Here is some documentation that seems to be organized along these lines (somewhat):

• CouchDB: https://docs.couchdb.org/en/stable/
• Avacado: https://avocado-framework.readthedocs.io/en/80.0/ *

backlink

Fuego Issues List