Email: Password: Remember Me | Create Account (Free)

Back to Subject List

Thread Closed: Became flame-war

???
07/31/08 14:30
Read: times


 
#157178 - The REAL issue with documentation
Responding to: ???'s previous message
Documentation should be complete and signed off before the first bit of code is written.

If it's done that way, the code will match the documentation and the end-user will be happy. If it's done in the usual way, i.e. requirements are ignored, code is written before requirements are established, code is changed at random without any written documentation of the changes, etc ... then you end up with the "usual" mess that software produces.

Every code module should be directly traceable to a system requirement. If there's anything included in the code set that is not justified by some specific requirement, it should be removed. Deliverable software (and harddware) should never include provisions for future expansion that are not specifically required.

If tech writers are required to "read the code" then there should be ample comments at each line. Ordinarily, tech writers are dismissed before the code is written. This is to avoid the notion that the needs of the coder can be accommodated by the document. The complete document must precede the assignment of the coder!

If it's done in any other way, the end result will be a mess! Requirements will be unmet, budget will be "busted", and schedule will be "in the toilet." The coder should be told, "Don't make it "kewl", make it do what the doc's say."

RE


List of 73 messages in thread
TopicAuthorDate
ATMEL AT89C52 Help?            01/01/70 00:00      
   Info            01/01/70 00:00      
      you are ignoring \'the standard\' and the fast            01/01/70 00:00      
         Not ignoring            01/01/70 00:00      
            it does not, but            01/01/70 00:00      
      Anyone want to write simple program for chip for u            01/01/70 00:00      
         \"a few hours\"???            01/01/70 00:00      
         No as simple as you may think            01/01/70 00:00      
            reply            01/01/70 00:00      
               Let's start at the beginning            01/01/70 00:00      
   A Serial Flash chip would be easier            01/01/70 00:00      
   Specification?            01/01/70 00:00      
      what about a "community project"?            01/01/70 00:00      
         Has anyone offered complete C++ for 805x?            01/01/70 00:00      
            yes??            01/01/70 00:00      
               Subset            01/01/70 00:00      
            Would Object Oriented Techniques Be Of Advantage?            01/01/70 00:00      
      Reply specs.            01/01/70 00:00      
         More specifications (and less)            01/01/70 00:00      
            Additional specs. Can you do it?            01/01/70 00:00      
               16 temperature inputs, relay outputs.            01/01/70 00:00      
                  problem is in software            01/01/70 00:00      
                     Lets first choose a chip.            01/01/70 00:00      
                        how many are you going to make?            01/01/70 00:00      
                        It is not just a voltage            01/01/70 00:00      
                  We want to keep it simple            01/01/70 00:00      
         MicroManagement ...            01/01/70 00:00      
         Narrowing it down            01/01/70 00:00      
            More specs again            01/01/70 00:00      
               ATMEL AT89C52            01/01/70 00:00      
                  More hw info needed            01/01/70 00:00      
                     Ok. thanks            01/01/70 00:00      
                        Don't assume. Don't "let's say". Go specific!            01/01/70 00:00      
                  dtraight from the horses mouth            01/01/70 00:00      
               Be Specific            01/01/70 00:00      
            shameless self-advertisement            01/01/70 00:00      
               Hi Jan, some user guide?            01/01/70 00:00      
                  documentation... is always a pain... ;-)            01/01/70 00:00      
                     sometimes "hobby projects" are better off            01/01/70 00:00      
                        what's that?            01/01/70 00:00      
                           a techwriter is            01/01/70 00:00      
                              oh I see            01/01/70 00:00      
                           The REAL issue with documentation            01/01/70 00:00      
                              ever done a hobby project, Richard? ;-)            01/01/70 00:00      
                                 not since the '60's ... well, maybe the '70's            01/01/70 00:00      
                                    well, IMHO, hobby projects are exactly the opposite...            01/01/70 00:00      
                                       remember the reference to Ultramon51?            01/01/70 00:00      
                                          the reward of hobbyist            01/01/70 00:00      
                                             the hobbyist does not need formal documents            01/01/70 00:00      
                                                hobbyist????            01/01/70 00:00      
                                             hobbyist - beginner            01/01/70 00:00      
                                                It's a tradeoff            01/01/70 00:00      
                                             Target goals and check lists            01/01/70 00:00      
                              naah            01/01/70 00:00      
                                 Smaller companies have to run fast            01/01/70 00:00      
                                    the sad thing is            01/01/70 00:00      
                                       Progress            01/01/70 00:00      
                     program interpreted from i2c eeprom?            01/01/70 00:00      
                        possible, but why?            01/01/70 00:00      
                           Waiting for first proposal for whole project?            01/01/70 00:00      
                              Waiting for complete and precise requirements            01/01/70 00:00      
                                 Lets keep on track.            01/01/70 00:00      
                                    A joke?            01/01/70 00:00      
                                       Well said            01/01/70 00:00      
                                       FOR SHAME !!!            01/01/70 00:00      
                                          Taunting?            01/01/70 00:00      
                                          You asked            01/01/70 00:00      
                                          There are AND gates that might work            01/01/70 00:00      
                                             Posible            01/01/70 00:00      
                                                Well ... depending on the relay ...            01/01/70 00:00      
                                                   Useful for others?            01/01/70 00:00      
                                    Off track? Not at all! Tell us what you want ...            01/01/70 00:00      
   shematic 1            01/01/70 00:00      

Back to Subject List