Showing results for 
Search instead for 
Did you mean: 

Best practices for neo4j database documentation


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...

  1. Serve as a reference to help me keep things straight
  2. Onboard new users/ developers faster
  3. 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).

Nodes 2022
NODES 2022, Neo4j Online Education Summit

On November 16 and 17 for 24 hours across all timezones, you’ll learn about best practices for beginners and experts alike.