|
Mike Hankey wrote: Why is it that we as programmers hate to document?
I wonder if there is a correlation between the dislike for wanting to write documentation and writing research papers. I don't care for writing documentation and I never cared much for writing research papers in college. I had to do it, but I didn't like it.
Thus, my hypothesis is, if you like writing in general, you will not mind writing documentation. 
|
|
|
|
|
When I first started in the industry, the standard was that documentation was to be completed before the first line of code. Some refer to that method as the waterfall method. Today, you seldom see documentation; or, what little there is seldom reflects the product for which it is written.
As a basic rule of thumb, write your documentation for an eight-year-old. (I used to have my daughter do the final edit of my documentation until she was eleven.)
|
|
|
|
|
Member 10707677 wrote: documentation was to be completed before the first line of code
That's just a specification. I've seen a few of those, read them, said "OK here's a better way to do that", and wrote something that actually made sense instead.
Where I am now I just keep saying "documentation is out of date as soon as it's published".
|
|
|
|
|
I've once read some self documenting code. I hit a point where I said to myself "that is just plain wrong logic". When I brought it to the attention of my manager, we couldn't change it because it was written per the spec document. I asked to see the spec document. I conceded the code did exactly what the spec said it should. She thought the matter was closed when I added "It's too bad it isn't doing what it is intended to do." We spent another hour going though the code to prove that what I saw in fifteen seconds was true. (fixed by changing "<" to ">" or vice versa)
|
|
|
|
|
Your mention of self-documenting code reminds me of my university days. One of my professors threatened to fail us if we didn't include comments in the source code. This was in the age when punch cards were still being used, so comments were a nuisance. One of the students turned in a final project with a single comment "RUN PROGRAM" as the first card of the deck. The result, when run, was a listing of the source code with accompaning commentary. Needless to say, he passed.
|
|
|
|
|
Member 10707677 wrote: documentation was to be completed before the first line of code. Some refer to that method as the waterfall method.
There seems to be different definitions for that method. Some studies have found the most successful projects used a combination of waterfall and agile methods combined. Waterfall starts with an overall plan and relationships. Those ideas are then documented separately breaking it into more plans and relationships. If you keep going like that you can easily get bogged down. Once you get down to about two-three levels, I can see the benefits of abandoning waterfall at that point and going to agile to get early results of the pieces documented to that point.
|
|
|
|
|
Early on I spent a great deal of time on documentation only to have it never referenced. I don't mind doing training materials because they are used, but developer docs are a waste of time because devs don't look at it.
|
|
|
|
|
For one thing, managers generally don't factor documentation time into coding deadlines, so if you spend time documenting it can look like you aren't getting your "real" work done fast enough.
But the larger problem is keeping it up-to-date. You may have time to do the initial documentation, but are you going to have time to update it with every change? What about when another team member ninja-edits the code, are you going to regularly check and make sure the documentation still matches the code?
I used to try very hard to have good documentation, but I found it to be hopeless. You end up with outdated documentation, which is often worse than no documentation at all. I don't buy the "code should document itself" argument, but for practical purposes that's where we're at, even if you have documentation you still have to go through the code and make sure the documentation isn't lying to you.
Edit: There's one time when documentation should be mandatory: when you are leaving a job. You likely aren't going to be needed to meet a coding deadline during your last two weeks, so spend that time documenting the systems you've been responsible for so the next person has something to go by when they pick up those systems. It's good karma, and that's when documentation is really needed and will get read.
modified 19-Dec-14 12:14pm.
|
|
|
|
|
Sometimes documentation (and programs) takes on a life of its own. I keep running across snippets of code and documentation I wrote forty-plus years ago.
|
|
|
|
|
As many of you know I'm passing CP through a fine comb to find spam.
After days spent searching, pointing them to the forum, reporting spam and spammer and soliciting cooperation in kicking them I began to ask myself: "self, why do this people post in their personal forums all this spam, normally the same, under a ton of accounts? What do they gain of this?".
A quick search on st. Google brought me this articl, that points to a research of the profitability of spam. For those interested, here is the linkity[^] to the article.
EDIT: found one more here clickity[^]
Enjoy!
Geek code v 3.12
GCS d--- s-/++ a- C++++ U+++ P- L- E-- W++ N++ o+ K- w+++ O? M-- V? PS+ PE- Y+ PGP t++ 5? X R++ tv-- b+ DI+++ D++ G e++>+++ h--- r++>+++ y+++*
Weapons extension: ma- k++ F+2 X
|
|
|
|
|
That simply goes for most advertising.
Bastard Programmer from Hell 
If you can't read my code, try converting it here[^]
|
|
|
|
|
I thought as much, but spam is actually negative, it is noise - it should give the opposite result, other than a sense of scam. I would never buy anything from such fishy figures, and I didn't think it could be so much profitable. I understand phishing - scams always work, and some phishing is actually well made. But spam... I never thought it could be so much profitable!
Geek code v 3.12
GCS d--- s-/++ a- C++++ U+++ P- L- E-- W++ N++ o+ K- w+++ O? M-- V? PS+ PE- Y+ PGP t++ 5? X R++ tv-- b+ DI+++ D++ G e++>+++ h--- r++>+++ y+++*
Weapons extension: ma- k++ F+2 X
|
|
|
|
|
How is advertisment not negative noise?
Bastard Programmer from Hell
If you can't read my code, try converting it here[^]
|
|
|
|
|
I agree but advertisement is an agreement from the supplier of a service to the user - basically using the service you accept the existance of advertisement.
Spam is an advertisement disguised as a pertinent information in a stream of informations, it is plain noise in the sense that it disturbs an otherwise functional communication. Like Jeovah Witnesses that ring the doorbell on unday morning, or the ones that stops people in the streets.
While I may not have anything against advertisement posters in the streets I will surely be annoyed by someone interrupting my flow of actions with commercials, especially foul-smelling as the typical spam.
Geek code v 3.12
GCS d--- s-/++ a- C++++ U+++ P- L- E-- W++ N++ o+ K- w+++ O? M-- V? PS+ PE- Y+ PGP t++ 5? X R++ tv-- b+ DI+++ D++ G e++>+++ h--- r++>+++ y+++*
Weapons extension: ma- k++ F+2 X
|
|
|
|
|
den2k88 wrote: ...be annoyed by someone interrupting my flow of actions with commercials,
Have you seen On-demand? It used to be that it acted like a dvd, hit a commercial, hit the fast forward button. A 2 minute commercial lasted 10 seconds. Now it seems the 2 minute commercial takes 4 minutes.
|
|
|
|
|
$65 million a year 
By the way have you tried this amazing product that enlarges your... Brain capacity? (well, that's where our brain is located according to women, anyway) 
My blog[ ^]
public class SanderRossel : Lazy<Person>
{
public void DoWork()
{
throw new NotSupportedException();
}
}
|
|
|
|
|
Sander Rossel wrote: By the way have you tried this amazing product that enlarges your... Brain capacity?
Does it enlarge the Bacon Lobe?
New version: WinHeist Version 2.1.0
There's a fine line between crazy and free spirited and it's usually a prescription.
I'm currently unsupervised, I know it freaks me out too but the possibilities are endless.
|
|
|
|
|
Quote: Three in every million spam emails sent solicits the desired action. O.k. so that’s only 0.0003%
More likely to hit the lotto.
New version: WinHeist Version 2.1.0
There's a fine line between crazy and free spirited and it's usually a prescription.
I'm currently unsupervised, I know it freaks me out too but the possibilities are endless.
|
|
|
|
|
Well yes but less expensive and on mass scale. Buying 1 million lottery tickets or playing 1 million lotto cards per day requires a significant investment, while sending 1 million spam mail or posts is inexpensive.
Really though, these numbers are incredible, I thought the would be much lower...
Geek code v 3.12
GCS d--- s-/++ a- C++++ U+++ P- L- E-- W++ N++ o+ K- w+++ O? M-- V? PS+ PE- Y+ PGP t++ 5? X R++ tv-- b+ DI+++ D++ G e++>+++ h--- r++>+++ y+++*
Weapons extension: ma- k++ F+2 X
|
|
|
|
|
If "There's a sucker born every minute" then doing the math;
9000 / (1440 min/day) = 6.25
Therefore it would only take 6.25 days to create the clientele.
New version: WinHeist Version 2.1.0
There's a fine line between crazy and free spirited and it's usually a prescription.
I'm currently unsupervised, I know it freaks me out too but the possibilities are endless.
|
|
|
|
|
I've never tried it, but apparently a lot of people dig the stuff spam-maker-hormel-sees-3q-profit[^].
"the debugger doesn't tell me anything because this code compiles just fine" - random QA comment
"Facebook is where you tell lies to your friends. Twitter is where you tell the truth to strangers." - chriselst
|
|
|
|
|
den2k88 wrote: I began to ask myself: "self, why do this people post in their personal forums all this spam, normally the same, under a ton of accounts? What do they gain of this?"
They do this out of compassion for you, because they know how much you need to play the role of guardian.
cheers, Bill
«OOP to me means only messaging, local retention and protection and hiding of state-process, and extreme late-binding of all things. » Alan Kay's clarification on what he meant by the term "Object" in "Object-Oriented Programming."
|
|
|
|
|
They're doing a damn fine job if that is the case - maybe they're overdoing that a tad but it's nice to have so many people caring for me, I'm moved  
Geek code v 3.12
GCS d--- s-/++ a- C++++ U+++ P- L- E-- W++ N++ o+ K- w+++ O? M-- V? PS+ PE- Y+ PGP t++ 5? X R++ tv-- b+ DI+++ D++ G e++>+++ h--- r++>+++ y+++*
Weapons extension: ma- k++ F+2 X
|
|
|
|
|
Last day at work in a week (24th).
Christmas in a week (25th).
Moving out of the house in a week (27th/28th).
Starting my new job in two weeks (jan. 2nd, which I didn't count because that's kind of included in the 'last day at work' (or vice versa)).
It sounds fun and not so fun at the same time
In any case I'll be glad when januari is over and everything feels a bit like normal again...
My blog[ ^]
public class SanderRossel : Lazy<Person>
{
public void DoWork()
{
throw new NotSupportedException();
}
}
|
|
|
|
|
Good luck you are tackling some very stressful situations. clickity[^]
New version: WinHeist Version 2.1.0
There's a fine line between crazy and free spirited and it's usually a prescription.
I'm currently unsupervised, I know it freaks me out too but the possibilities are endless.
|
|
|
|
General 
News 
Suggestion 
Question 
Bug 
Answer 
Joke 
Praise 
Rant 
Admin 
Submit an article or tip
