Documentation
-
Just started writing some documentation which I have never done before, at least not on a professional way. Going good so far, actually thought it would a be a nightmare because of my [lack of] writing skills but it's not so bad... Is documentation a part of software development you like to do?
In a complex project documentation should be part of it not an afterthought. Satement Of Work, Requirements, Development Plan, Test Plan etc.. I spent a number of years developing test solutions for a wide range of technologies (fibre optics and liquid nitrogen don't mix well!) and without that we would have floundered.
Join the cool kids - Come fold with us[^]
-
Just started writing some documentation which I have never done before, at least not on a professional way. Going good so far, actually thought it would a be a nightmare because of my [lack of] writing skills but it's not so bad... Is documentation a part of software development you like to do?
Fabio V Silva wrote:
Is documentation a part of software development you like to do?
Yeah, actually I do. OK, I'm weird. I like dead repeat offenders. I like writing documentation. It's a good weapon against repeat offenders. RTFM!!!! ;) Marc
-
Just started writing some documentation which I have never done before, at least not on a professional way. Going good so far, actually thought it would a be a nightmare because of my [lack of] writing skills but it's not so bad... Is documentation a part of software development you like to do?
BAH! If you can't read my source code, you don't deserve to use my program. ;P
-
BAH! If you can't read my source code, you don't deserve to use my program. ;P
I don't expect users to understand source code...in fact I don't want them to see it :doh: So it is necessary to create documentation...
-
Just started writing some documentation which I have never done before, at least not on a professional way. Going good so far, actually thought it would a be a nightmare because of my [lack of] writing skills but it's not so bad... Is documentation a part of software development you like to do?
Software documentation is ok - it's part of the job - but I hate doing User documents. I just have difficulty thinking "down to their level", and tend to leave out things I think are "obvious". Or I go the other way and come over too patronising. Difficult.
Real men don't use instructions. They are only the manufacturers opinion on how to put the thing together.
-
Software documentation is ok - it's part of the job - but I hate doing User documents. I just have difficulty thinking "down to their level", and tend to leave out things I think are "obvious". Or I go the other way and come over too patronising. Difficult.
Real men don't use instructions. They are only the manufacturers opinion on how to put the thing together.
Your sig speaks for you :laugh:
-
Fabio V Silva wrote:
Is documentation a part of software development you like to do?
You had to ask? Nobody likes to write it, and everybody whines how bad it is when they read.
Somebody actually reads it?
A while ago he asked me what he should have printed on my business cards. I said 'Wizard'. I read books which nobody else understand. Then I do something which nobody understands. After that the computer does something which nobody understands. When asked, I say things about the results which nobody understand. But everybody expects miracles from me on a regular basis. Looks to me like the classical definition of a wizard.
-
Just started writing some documentation which I have never done before, at least not on a professional way. Going good so far, actually thought it would a be a nightmare because of my [lack of] writing skills but it's not so bad... Is documentation a part of software development you like to do?
Sometimes, actually. I find my documentation-writing-happiness quite well reflects the state of the project. For end user doc: Documenting a well-written feature with an overview, howto-s, pro tips and some nice screenshots is a bliss. It still takes a while to get it right and make it look good, but it's part of the polish. Documenting a feature I feel uneasy about - e.g. it's an awful compromise between user expectations and our willingness to deliver, or I see drawbacks that I have to downplay for political reasons - that hurts. The same goes for development docs - writing specs, adding comments etc.
Agh! Reality! My Archnemesis![^]
| FoldWithUs! | sighist | WhoIncludes - Analyzing C++ include file hierarchy -
Just started writing some documentation which I have never done before, at least not on a professional way. Going good so far, actually thought it would a be a nightmare because of my [lack of] writing skills but it's not so bad... Is documentation a part of software development you like to do?
-
Just started writing some documentation which I have never done before, at least not on a professional way. Going good so far, actually thought it would a be a nightmare because of my [lack of] writing skills but it's not so bad... Is documentation a part of software development you like to do?
Hot off the presses: "A Coder’s Guide to Writing API Documentation" (via MSDN Magazine)
