This is the first edition of the project documentation, compiled in a form of a short book. It's still work in progress, which means a lot of errors and unfinished pages. If you see an error you think is easily fixable or you think you've just spotted one you can let us know by creating an issue on github.
What does the documentation contain?
It contains information about the exact processes that come together to make up the general architecture, which we call the Outcome architecture.
It also covers things that are not directly related to the specification of the architecture, but still are relevant to the process of working with it.
Who is this documentation intended for?
It's for anyone who wishes to understand the design behind the simulations, how they are run, how the data for those simulations can be created and handled, among other things.
Getting a good grip on the conceptual make up of the architecture, on what kinds of objects are involved and how they relate to each other, is recommended before getting into writing module files.
Aiming for accessibility
Documentation for this project is meant to be easy to read and understand by anyone who doesn't have any prior experience with computer programming or game modding (modification).
That said, this first edition is not kept up to this high standard of accessibility. It still contains things that can be considered to require some prior experience/knowledge related to the categories mentioned above. The goal for the next editions will be to further refine the documents in this book to:
- reduce usage of highly "industry-specific" terms, and
- increase the number and quality of explanations where the above is not possible