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

Back to Subject List

Old thread has been locked -- no new posts accepted in this thread
???
04/01/05 13:17
Read: times


 
#90803 - my experience and methods
Responding to: ???'s previous message
I have yet to see ANY separate document that match the software, thus, my attitude is that no text should exist outside the code.

When I start a project I typically decide which modules I will have and equip these modules with functions with no actual code.

an example
/////////////////////////////////////////////////////////////////////////////////
//
//  U8 FetchKbdChar(void)
//
// return character from keyboard if any or zero if none
//

U8 FetchKbdChar(void)
{
U8 dummy;
  
  dummy = 0;
  return(dummy); // patch dummy in the ICE to test calling func
}


The next step, then is to make the main() function with the skeleton functions.

Then start filling out the skeletons.

This way you get most decisions made before too much code is written AND the documentation is done BEFORE the code.

Some will like this approach, some will not. I am not saying this is the right or the only way, but it works for me.

Erik

List of 12 messages in thread
TopicAuthorDate
Firmware Documenation and Planning            01/01/70 00:00      
   Firmware doc            01/01/70 00:00      
      Code Complete            01/01/70 00:00      
   Some tips            01/01/70 00:00      
      my experience and methods            01/01/70 00:00      
         I use similar methods            01/01/70 00:00      
            I agree...            01/01/70 00:00      
   Read Jack Ganssle            01/01/70 00:00      
      Will check this out            01/01/70 00:00      
   mil-std-2167            01/01/70 00:00      
   Hardware documentation?            01/01/70 00:00      
      Hardware documentation? (different)            01/01/70 00:00      

Back to Subject List