On Feb 17, 2011, at 10:19 AM, Ricardo Aráoz wrote:
> OTOH if you are *using* (as opposed to modifying) the
> framework you only want to interact with the help documents, as the
> final aim is not to understand how the framework works but only to
> understand how to *use* the framework. That is why docstrings and help
> documentation are not the same.
Just saw this article that sums up my feelings on what sort of
documentation is most important:
http://www.azarask.in/blog/post/write-the-manual-first/
If someone is serious enough to want to modify the framework, they can
find stuff out better than the average user of the framework. Top priority
should be directed towards helping framework *users* understand how to use it.
-- Ed Leafe
_______________________________________________
Post Messages to: [email protected]
Subscription Maintenance: http://leafe.com/mailman/listinfo/dabo-users
Searchable Archives: http://leafe.com/archives/search/dabo-users
This message:
http://leafe.com/archives/byMID/[email protected]
