What is the guidance on how build documentation about the content and structure within a graph database? And/Or, are there standard templates that people use?
I want to develop documentation to...
- Serve as a reference to help me keep things straight
- Onboard new users/ developers faster
- Teach my students about proper documentation techniques.
Right now I have information in an Excel-based ontology file, pages within a OneNote notebook, and commented code in python. That is, very-little lives only in my head (good), but the information is scattered (bad), so it would be extremely difficult for anyone to work with the db if I were hit by train (very bad).