User documentation can be:
- manuals for end-users of the product
- manuals for the system administrators.
- User documentation includes tutorials, user guides, troubleshooting manuals, installation, and reference manuals.
- FAQs
- Video tutorials
- Embedded assistance
- Support Portals
In the docs sprint we have decided on the following structure for the user page:
proposed structure of user main page
(https://docs.softwareheritage.org/user/)
(https://docs.softwareheritage.org/usage/)
(https://docs.softwareheritage.org/service/)
How to use the SWH archive(non-technical)
- Getting started (tutorials)
- searching an origin
- browsing code
- Howto
- get and choose a swhid
- list visits
- save code now
- with the web platform
- with the API
- search metadata
- Explanation
- why SWH?
- architecture
- pull vs push
- delay/lag
- ...