Page MenuHomeSoftware Heritage

Create strategy for documentation with a map or a full table of content
Started, Work in Progress, HighPublic

Description

Since we have many entry points we should review the current map of documentation and create a uniformed strategy for what goes where and for whom.

Event Timeline

moranegg created this task.

For whoever who want to work on this (and on doc restructuring in general), I recommend to watch this talk: https://www.youtube.com/watch?v=t4vKPhjcMZg , which provides a good taxonomy of the kind of docs that exist. Our GSoD 2019 application page also contains a lot of useful related work.

@zack very good video!
Here is a short summary from the video (Daniele Procida) and from Divio's documentation website:
https://documentation.divio.com/
Four different functions:

I'm going to open a task to try this approach with the deposit documentation.

This comment was removed by moranegg.
This comment was removed by moranegg.
This comment was removed by moranegg.
moranegg changed the task status from Open to Work in Progress.Feb 10 2021, 4:34 PM