<February 2023>

On this page...



Member of...

ASP Insiders

MVP Visual Developer ASP/ASP.NET

Enter CodeZone

Blog Categories



Deutsche Resourcen


Sign In

#  Wednesday, July 28, 2004

There is a great article on linux.com (you didn't expect such a link here, did you?) titled SysAdmin to SysAdmin: It's the documentation, stupid! It is about a topic that is close to my heart: developers don't like writing documentation, and keep telling you (user) that the source is the documentation - which I couldn't agree with less, even if I am a programmer-user.

Now though this article is targetted at Open Source projects, you will agree that you too have seen less-than-stellar documented projects in companies (even yours), or you had to work with third party software whose documentation left to be desired. How did you feel when you had to find out how to achieve a task? Right.

Having this said, I'd like to offer a great starting point for writing technical documentation: quite some time ago, Bernd (de) wrote an article titled Technical Writing Made Easier, specifically targetted at programmers. Check it out.

Categories: this
Wednesday, July 28, 2004 1:01:48 PM (W. Europe Daylight Time, UTC+02:00)  #    Comments [1]


Wednesday, July 28, 2004 11:06:28 PM (W. Europe Daylight Time, UTC+02:00)
rtfm or not, you're the one and only blfh! ;-)
Comments are closed.

© Copyright 2023 Christoph Wille

newtelligence dasBlog 2.3.9074.18820
Subscribe to this weblog's RSS feed with SharpReader, Radio Userland, NewsGator or any other aggregator listening on port 5335 by clicking this button.   RSS 2.0|Atom 1.0  Send mail to the author(s)

Don't contact us via this (fleischfalle@alphasierrapapa.com) email address.