Like Tree1Likes
  • 1 Post By clancyPC

Documentation for a C program

This is a discussion on Documentation for a C program within the C Programming forums, part of the General Programming Boards category; Basically if I employed you to write a C program for me what documentation would you expect me to hand ...

  1. #1
    Registered User
    Join Date
    Dec 2001
    Posts
    38

    Documentation for a C program

    Basically if I employed you to write a C program for me what documentation would you expect me to hand you to work from. I have a requirements specification, data flow diagrams, entity relationship model and information on all the data items that will be involved in the program.
    sachin soni likes this.

  2. #2
    ....
    Join Date
    Aug 2001
    Location
    Groningen (NL)
    Posts
    2,386
    You're quite complete. Usually the client only offers a User Requirements Specification.

  3. #3
    and the hat of wrongness Salem's Avatar
    Join Date
    Aug 2001
    Location
    The edge of the known universe
    Posts
    32,335
    The only other thing you need is a test plan, cross-referenced to the requirement specification, which allows you to run an agreed set of tests, to show you that all the requirements have been implemented.

  4. #4
    Registered User
    Join Date
    Dec 2001
    Posts
    38
    Thank you both for your prompt replies.
    The follow on question would be how do you turn the logical design into the practical design. My C programming has mostly been bug fixing and upgrading old programs. Now I have done the analysis for a new program, but I have never written a program from scratch before, so I am a bit unsure of the next stage. I have done some flow charts of how I think the main logic will work, and some pseudocode for the major algorithms, am I going in the right direction?

  5. #5
    and the hat of wrongness Salem's Avatar
    Join Date
    Aug 2001
    Location
    The edge of the known universe
    Posts
    32,335
    > am I going in the right direction?
    Yes

    > I have done some flow charts of how I think the main logic will work, and some pseudocode for the major algorithms
    You basically continue this process until you're reasonably confident that you understand all the issues. Complex areas will obviously need more work and attention.

    You should be aiming to get something which hangs together (no loose ends or unexplained bits), and where you think each line of pseudo code would translate to say 3 to 5 lines of C

    When you're done, it really helps if you can find someone to review the design with you, to help sort out any problems.

  6. #6
    ....
    Join Date
    Aug 2001
    Location
    Groningen (NL)
    Posts
    2,386
    >..how do you turn the logical design into the practical design.

    I think this cannot be learned just from books. It takes experience to really understand how to do this. So this time it will be quite hard, but next time it'll be a little easier. But it never will be really easy.

Popular pages Recent additions subscribe to a feed

Similar Threads

  1. Need help with a program, theres something in it for you
    By engstudent363 in forum C Programming
    Replies: 1
    Last Post: 02-29-2008, 12:41 PM
  2. Replies: 4
    Last Post: 02-21-2008, 09:39 AM
  3. Using variables in system()
    By Afro in forum C Programming
    Replies: 8
    Last Post: 07-03-2007, 12:27 PM
  4. Replies: 3
    Last Post: 03-04-2005, 01:46 PM
  5. My program, anyhelp
    By @licomb in forum C Programming
    Replies: 14
    Last Post: 08-14-2001, 10:04 PM

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21