Archives

Posts in September 2009

Documentation: the missing tyre

Technical documentation is everywhere, and pretty integral to software development. But a lot of documentation is:

Poorly explained
Missing significant parts
Lacking depth

(or a combination)
After all, documentation is the “missing tyre” of project management:

But let’s face it, writing documentation is hard. Software projects, especially large ones, are constantly changing, with bits being added, removed or changed, and sometimes anticipating how your audience of developers …

Are you familiar with the Apple Human Interface Guidelines? It is a document which outlines how good OS X applications should look and behave in order to maintain the consistent look and feel of applications across the Mac platform (and the iPhone for the iPhone Human Interface Guidelines).
Personally, for any document of considerable length which I will undoubtedly spend a …