Comments | kittenpants: Functional Approach to Documentation

kittenpants

Functional Approach to Documentation

Jan 03, 2006 09:01

I have a love-hate relationship with documentation. I'm not the best at remembering to comment my code, but after working in a documentation-free environment for three years, that bad habit is not just broken, but is huddled in the corner crying, begging for the pain to stop, oh God, I'll be good, I promise, just make the bad coders go away. Erm ( Read more... )

geek

Comments 14

rowangolightly January 3 2006, 16:25:31 UTC

...that makes me 'conceptual'. Or 'dummy'...take your pick. I ain't proud!

(The comment has been removed)

kittenpants January 3 2006, 16:34:49 UTC

What is this "tech writer" and "hiring somebody to write the documentation" thing of which you speak? DST didn't have any of that fancy stuff. (shudder)

::sigh:: Yeah, you're right.

This is why..... teross50 January 3 2006, 17:43:37 UTC

This is why I just stuck to A+ and networking servers and domains. Programming just confuses me all together. I have always admired programmers for their math like minds.

Just one of the many ways you are gifted. My dear one.

Tech Writers adriang January 4 2006, 01:43:00 UTC

Actually, if you're talking about the DST that I'm thinking of, DST does have technical writers. Unfortunately, they have far too few of them, so most of us programmers have to write our own documentation and hope that it's sufficient to help us keep from getting paged. 8-)

Adrian

Thread 7

(The comment has been removed)

acidentphlosoph January 3 2006, 17:55:12 UTC

that name... pure beauty

(The comment has been removed)

acidentphlosoph January 3 2006, 21:18:35 UTC

exactly

diermuid January 3 2006, 18:02:27 UTC

With the new CASE technologies that the schools keep preaching about, the documentation is mostly written by the tools. Neat, eh?

Unfortunately, I have been doing homework on CASE for 15 years and have yet to see it really implemented in the corporate world.

I'm still trying to get my team to write the customer documentation for the customers. To date, that still seems a goofy concept to most others in the field.

acidentphlosoph January 3 2006, 21:20:26 UTC

I was a computer engineering/science major for a while. I know a (in?)decent amount of programming. What on Earth are you talking about?

Which program?

kittenpants January 3 2006, 22:00:23 UTC

No specific program. The examples are all hypotheticals. The following are variable strings: $juggler, $yark, $gleem, $bjark, $fleeblejack, $counter-bjark, $watoori. I needed more variables than the canonical hacker $foo, $bar, $baz, etc, and needed some to be noun-ish and some to be verb-ish, so I made some up. Here's a couple of ways to populate the variables:
case (jrandomprogram == GIMP ( ... )