News for hackers. Stuff that matters.
Re:Things People Hate about Your Open Source Docs by dmckeon on Friday June 21, 2013 @02:02PM (#5919828)
The info nav system can be avoided with:

    info () { command info "$@" 2>&1 | less; }
to get the content with a more (or less) familiar nav tool.

Another useful approach is to 'project the document' rather than to 'document the project'. Write the draft documents as part of the specification and development process. Code the project. Finally, edit the docs to match the code.

You get to capture the state of early energy and an over- or top-down view before diving into the code, and will remember to mention details of the design while they are fresh and new, rather than at the end of the coding process, when everything has become so familiar that it all seems trivially obvious.

There are no comments on this comment yet.