search

mbakker7 / timml

An analytic element model for steady multi-layer flow
MIT License
38 stars 21 forks source link

start of new docs #93

Closed mbakker7 closed 1 year ago

mbakker7 commented 1 year ago

This is a work in progress.

Hugovdberg commented 1 year ago

This might be a good moment to take a look at this page, which proposes a four way split in the documentation for very specific purposes.

mbakker7 commented 1 year ago

Interesting suggestion, @Hugovdberg . We will definitely consider that. Just trying to wrap my head around the difference between a 'tutorial' and a 'how-to-guide'. Not quite sure I have that clear in my head.

Hugovdberg commented 1 year ago

To quote that site:

How-to guides are wholly distinct from tutorials and must not be confused with them:

A tutorial is what you decide a beginner needs to know.

A how-to guide is an answer to a question that only a user with some experience could even formulate.

So a tutorial could be just a getting started with TimML from scratch, whereas a how to would be more like How to add a building pit in a inhomogeneity, where you can assume the user knows how the software works in general.