Category Archives: documentation

Tips for Effective Documentation

Oct 14

Writing technical documentation is required task for many developers.  Once you start producing documentation you quickly learn good documentation is more than just screen shots. You will be required to write and express complex concepts. Documentation can be very challenging. Especially if you are not comfortable writing for non-technical users. It is a skill like [...]

By admin | Also posted in Uncategorized | Tagged , , , | Comments (4)

Usable Subversion Comments Part 2

Jul 24

Part 2 of usable subversion comments is about what to include in svn comments.
The content of subversion comments can vary depending on what is being checked in. My conclusion is that content of the comments should be functional. One can go into great detail, or be fairly abstract. This should still be [...]

By admin | Also posted in comment, source control, svn | Comments (0)

Usable Subversion Comments

Jul 23

I notice that when I am browsing subversion repositories, many times depending on the culture there can be little in the way of usable comments, and depending on the number of individuals the format and style of these comments can vary wildly, I was even looking back at some of my worst offenders, blank, or [...]

By admin | Also posted in comment, source control, svn | Comments (0)
Profile Picture

About Ian Lintner


I am a software developer, mostly web,  in Des Moines, Iowa. I take a very opinionated stand concerning development, you will never regret a simple design or architecture. My education was at Drake University in Biology and Computer Science. Offline I am recently married to my wife Heather. I try my hand at many hobbies currently I am gardening till the snow comes in.



My Current Projects


Des Moines Twitter Trends