| ??? 03/10/06 14:36 Read: times |
#111903 - too late and totally wrong Responding to: ???'s previous message |
Do you document as soon as you finish a module in a project, or after completely finishing a project? In other words, what are the practices you follow for documentation purposes?
the most important "document" is the one you write before you write one single line of code. This "document" describes why, what and how. I know very few that use Hurley before they grab Kochan and if you do not grab Hurley first, your profesdsional life will be slower and more troubled. As to "documentation" as usually referred to my "rules" are 1) no documentation outside the source code except the user manual. 2) lots of documentation in the source code 3) all documentation in the source code as close to what they document as possible. Erik OH, by the way Hurley: "Logic" Kochan: "Progarmming in ANSI C" |
| Topic | Author | Date |
| How do you manage Documentation? | 01/01/70 00:00 | |
| As soon as you finish?? | 01/01/70 00:00 | |
| User Manual | 01/01/70 00:00 | |
| it all is very simple | 01/01/70 00:00 | |
| too late and totally wrong | 01/01/70 00:00 | |
| you have an easy life won't you | 01/01/70 00:00 | |
| Of course, you only have enough informat | 01/01/70 00:00 | |
| more on the above, the beauty of the hoo | 01/01/70 00:00 | |
| in C? | 01/01/70 00:00 | |
| please do not accuse me of unnatural act | 01/01/70 00:00 | |
| Design Info | 01/01/70 00:00 | |
| viewpoint | 01/01/70 00:00 | |
| General Principles | 01/01/70 00:00 | |
| the clients... | 01/01/70 00:00 | |
| Client Variety | 01/01/70 00:00 | |
| It's like I said last month ... | 01/01/70 00:00 | |
| Great | 01/01/70 00:00 | |
| I, J OK | 01/01/70 00:00 | |
| Repetition | 01/01/70 00:00 | |
| My old DOS based suite... | 01/01/70 00:00 | |
| Two categories | 01/01/70 00:00 | |
MIL498 | 01/01/70 00:00 | |
| write the documentation first | 01/01/70 00:00 | |
| Good points.. | 01/01/70 00:00 |