Technical Documentation
TechWriter.dk - Are You a Good Technical Writer? - Rant-style piece on doing technical documentation.
Writing Good Documentation - How to approach the task as “a set of generic guidelines”
Writing and Programming - Next of Kin - Juxtaposing writing and programming as similar activities. Very interesting - I think I’ve heard about academic studies on analogies between program code and literature - anyone?
In our thesis we should be able to explain and convey very complex software in the best possible way.
Text, code examples, software diagrams and how-to’s/guides should be different perspectives on the same software, but balancing these perspectives into the perfect output is no simple matter.
Just think about it. Again and again.