LWN.net Logo

Better documentation: the window of naive interest

Better documentation: the window of naive interest

Posted Jul 5, 2012 7:40 UTC (Thu) by zuki (subscriber, #41808)
Parent article: Better documentation: the window of naive interest

Maybe it's just me, but the wireframe+sticks+fabric+skin analogy to documentation just doesn't make sense.


(Log in to post comments)

Better documentation: the window of naive interest

Posted Jul 7, 2012 0:18 UTC (Sat) by neilbrown (subscriber, #359) [Link]

Thanks for the feedback. I'm sorry the analogy didn't work for you. Probably I didn't explain it very well.

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