The SWH world is vast and newcomers have different entry points to understand it and contribute to it.
With a couple of user stories we can improve the documentation structure and inter-linking.
- wiki
- dev-doc
- the forge
- mailing lists
- website
- guidelines
- articles
- archive
All have very valuable information.
This can be also useful for a Google Season of Docs or an external writer.
The template can be :
As <who> <when> <where>, I <want> because <why>
For example:
who | when | action | why | where documented now | where should be | provided by |
---|---|---|---|---|---|---|
a researcher | publishing an article | save my repo in the SWH archive | to make it citable | in the website guidelines | ? | MG |