3 ms·
Fair point, though I'd argue that's not its function. Documentation is a technology, and all technology serves a goal-oriented process.[1] What you're looking
by dredmorbius 5y ago
Fair point, though I'd argue that's not its function.
Documentation is a technology, and all technology serves a goal-oriented process.[1]
What you're looking for is a Quick Start Guide. These exist. Vimtutor would be an excellent example.
This ... is a map of the landscape. It doesn't tell you where to go, or what the highlights are. But if you happen to be in one part of the landscape, or want to know what's in some remote part, this shows you both what's where and how to get there. And links to a detailed description for closer inspection.
And in that process and to that goal, it really is quite good.
________________________________
Notes:
1. That is a bald statement proposed as but not presumed true. Change my mind!
- sodapopcan 5y agoThat’s what I always assumed this was. You’d be nuts to show this to a beginner.
- dredmorbius 5y agoPretty much. Or you'd want to show it to a beginner as a phased reveal. That might actually make an interesting evolution of the diagram, which I'm visualising in my mind as either a set of concentric circles or regions of expanding complexity, or a set of 3D-relief "peaks" emerging from a "feature sea", where the basic elements (say, the Insert mode entry points, h/j/k/l keyboard movements, and, um, how to quit, might be covered. With more advanced functionality exposed as deeper / more remote regions of the map.