Not logged in
Log in now
Create an account
Subscribe to LWN
An unexpected perf feature
LWN.net Weekly Edition for May 16, 2013
A look at the PyPy 2.0 release
PostgreSQL 9.3 beta: Federated databases and more
LWN.net Weekly Edition for May 9, 2013
Better documentation: the window of naive interest
Posted Jul 7, 2012 0:18 UTC (Sat) by neilbrown (subscriber, #359)
The analogy was not meant to be with the documentation exactly but with the mental model you build. While you a reading a document you build a model in your mind of the thing being described. A model has various elements which I identified with the wire-frame, substance, and skin of a physical model.
The document needs to support the creation of all of these elements in your model by describing structure, purpose, and examples.
I hope that helps.
Copyright © 2013, Eklektix, Inc.
Comments and public postings are copyrighted by their creators.
Linux is a registered trademark of Linus Torvalds