Perfect Documentation

strange_cliffs.pngI just realized this while doing programming, but it should also be applicable for any other documentation, such as documentation for audio software and so on. The best documentation is documentation that anticipates what the end user needs, and presents this at the right moment.

In my case I needed a quick answer how to transform mouse down coordinates from a window context to a view context (Cocoa programming). The NSEvent documentation mentioned this in the right position. This as I suspect anyone dealing with this issue needs the answer.

So, concerning other audio tools, such as Ableton Live documentation, if most common operations are discussed, that’s a good thing. I think this is something that I have not seen in basic documentation. Sometimes you have how-to sections, but it would indeed be handy to include common issues in the actual base documentation.

So anyone working on DAW documentation, please listen. The more common answers you reply to in the documentation, the better.

Leave a Reply