3 ms·
One idea about design I take from pg is that it's difficult to "even talk about good or bad design except with reference to some intended user." [1] Now, I'm r
by evanrmurphy 16y ago
One idea about design I take from pg is that it's difficult to "even talk about good or bad design except with reference to some intended user." [1]
Now, I'm relatively new to literate programming, and perhaps the answer to my question(s) will be obvious to someone more experienced with it. What I wonder though every time I read about it is, who is the intended audience of all this extensive documentation? More specifically, how much knowledge of the programming language and problem space do we presume that the reader has?
There is something elegant about presuming the audience has expertise in both areas. That way you only have to worry about documenting one thing, the program, rather than three things: the program, the programming language and the problem space. Readers lacking sufficient understanding of the lang or problem space can refer to the more robust documentation about either one individually to get themselves up to speed. But I'm not sure Docco users are taking this approach.
---
[1] http://www.paulgraham.com/desres.html http://www.paulgraham.com/desres.html
- steveklabnik 16y agoPersonally, I try to write at the same level that I always would for code, with maybe a larger preamble at the beginning. Then again, I'm still a student of the ways of the literate myself...