4 ms·
> there’s at least (at least) two more kinds of docs you’ll want: These already exist within the 4 models described. > Conceptual Overviews That's an explana
by jasonlotito 3y ago
> there’s at least (at least) two more kinds of docs you’ll want:
These already exist within the 4 models described.
> Conceptual Overviews
That's an explanation. It's covering the understanding. That's the purpose of that document.
> (“Aren’t these just a kind of explanations?” Explanations are intended for people who already know, or are in the process of learning, your subject. It comes after the tutorial. Conceptual overviews come before the tutorial. They are for people who are getting ready to learn the subject, or for outsiders evaluating if they want to learn it.)
This is wrong. When you start reading the documentation, you have started the process of learning. An explanation before is fine. The overview is literally a part of learning about the topic. Where it sits is immaterial. The purpose and the intent is important.
> Snippets and Examples
That's How-Tos.
> Imagine I present you an example of a code, and then an example of the same code, optimized. I’m not giving you a rote how-to on optimizing code, I’m demonstrating a way of thinking about optimizing code. It all comes back to the mental model.
You are demonstrating "how to think about optimizing code."