Bring Documentation IG examples of good documentation sites

[saragon02]

Examples

• https://python.langchain.com/docs/get_started/introduction

• https://iiif.io/get-started Two routes for onboarding: end user or implementer

• https://www.archivematica.org/en/docs/archivematica-1.15/ User manual documentation is organized according to tabs that appear in the software, which in turn is organized in the order of routine tasks completed by archivists. Our user oriented documentation might be organized by routine tasks a depositor completes.

Add new links either to this issue or in Discord

[hbayindir]

I can suggest Diataxis approach. It basically divides documentation to four main types, with clear goals and styles.

It doesn't need a "burn to the ground/rewrite" approach either. One can just start adapting the documentation page by page to this method. We use this on our cluster/user documentation, but unfortunately it's in Turkish. If you want to give it to a translator it's at https://docs.truba.gov.tr

[fenekku]

@hbayindir woah this approach clearly formulates so many principles I hold dear well beyond documentation

• systematic approach
• experience before understanding
• iterate between your work and thinking about your work
• apply apply apply

Thank you for that :pray:

[hbayindir]

@fenekku very happy to hear that. I'm becoming a low-key documentation geek myself, and it helped me a lot. Glad that it helped someone else, too.

Cheers!

[ptamarit]

One example I can think of:

• React Router: Nice landing page guiding reader to the most relevant page depending on their needs.

[saragon02]

• Hyku Implementations, simply listed in a Wikipedia-style table: https://samvera.atlassian.net/wiki/spaces/hyku/pages/819724378/Hyku+Implementations
• Samvera Knowledge Base: https://samvera.github.io/