This project is built and maintained in LaTeX, XML (using RDF and OWL), and HTML.
The Modules directory contains sectionally complete and descriptively precise chunks of documentation; these chunks are larger than sentences, smaller than chapters, and not subject to a particular ordering of the content, so they can be placed anywhere and used as source documentation.
A shorter and more concise Ethereum specification functions as a companion piece to the ontology.
When defining formal math operations, e.g. those from the Yellowpaper, we use pseudocode. Anyone can write pseudocode by imagining whatever process you're trying to describe in terms of operational steps:
first do this then do that
The Ontology classifies the data stored in each module in logical relation to its component and exponent parts.
- Build documentation that is broad enough to be helpful to all readers.
- Build documentation that is deep enough to be a utility for all developers.
- Build documentation that covers all necessary facts, and only those facts.
- Build documentation that fosters global, systematic, and intuitive clarity about Ethereum.
Links to several but not all of the various resources cited can be found in the references directory.