documentation | iface thoughts

Mar 10, 2008

My Mom Is Not Going To Read This Code

Somehow a lot of software professionals believe that my Mom will read this code. Or at least they want me to document it such that even she could read it. Why don’t they see the problems? [Continue]

Nov 1, 2007

It Does Not Work As Documented

While many of you might consider this bad and unprofessional, I think importance of documentation can vary by project. Linus Torvalds recently said about Linux kernel: Rule #1 in kernel programming: don’t *ever* think that things actually work the way they are documented to work. The documentation is a starting point, nothing else. [Continue]

Jul 5, 2007

JDocs - Java API Documentation

Dion Almaer noted that JDocs is now AJAX powered. JDocs is a place where you can search for Java API documentation for various libraries. There are others out there like gotAPI and Javaref, however JDocs lets you contribute to the documentation through annotations. [Continue]

Dec 7, 2006

CSS Documentation Shortcut

CSS Documentation Shortcut (via Ajaxian) is a reference guide for CSS. It redirects you to the W3C help on a specific CSS property or to the Google results in case it is not found. As an additional incentive there is also a typeahead facility that will help you in case you are not sure about the spelling. [Continue]

Nov 19, 2006

Documentation For?

Documentation is probably one of the most hated subjects for most of the developers. The biggest reason is it is often difficult and tedious to be articulate in specifying what to do or what has been done. I have mentioned earlier why documentation is necessary for the user, in one form or another. [Continue]

Jul 24, 2006

API Reference Heaven

This post has already been published on code::gallery blog which now has been merged into this blog. Found a very useful site for API reference - gotAPI (via Curt’s Comments). It is simply great to get all the searchable documentation for scripts and programming languages at one place. [Continue]

Feb 9, 2006

Documentation Is Not Optional

Have you felt frustrated when you hit F1 and the help didn’t show up? Would it have helped you and saved you a bunch of head bangs? One of the important things I have learnt in my experience of developing and using software is that the said benefit is derived only if it is used; and derived to the fullest only if it is used right. [Continue]