= Documentation

via https://www.harudagondi.space/blog/rust-documentation-ecosystem-review

Quality of documentation is quantified by:

    Comprehensiveness — the amount of substance on the topic
    Discoverability — how easily can you explore new topics
    Philosophy — knowing the reasoning of the choices made in the library
    Approachability — is the documentation intimidating or not

image by diataxis:

    {tutorials, explanation} for aquisition ← → application by {how-to guides, reference}
    {tutorials, how-to guides} for action ← → cognition by {explanation, reference}

What are these specifically?

• A tutorial is a practical learning experience, where the user learns by doing.
• A how-to guide is a manual that addresses a real-world goal or problem.
• A reference is a factual collection of documentation that contains the technical description.
• An explanation describes the philosophy and provides context on why something is so-and-so.