Thread: Documenting Source Code

Hybrid View

Previous Post Previous Post   Next Post Next Post
  1. #1
    C++ Developer XSquared's Avatar
    Join Date
    Jun 2002
    Location
    Ontario, Canada
    Posts
    2,718
    Eh, for us it isn't that bad. Just 1500-2000 words analyzing something for the company we did a co-op term at. Luckily for me, my boss already filled out the evaluation form, so now I just need to come up with a report.
    Naturally I didn't feel inspired enough to read all the links for you, since I already slaved away for long hours under a blistering sun pressing the search button after typing four whole words! - Quzah

    You. Fetch me my copy of the Wall Street Journal. You two, fight to the death - Stewie

  2. #2
    Malum in se abachler's Avatar
    Join Date
    Apr 2007
    Posts
    3,195
    Well, my daily report is just maybe half a paragraph paraphrasing what i did that day, basically 2-3 sentences. The weekly report is really just all the daily reports copy and pasted together in one form. The monthly is the big one, usually one page detailing what was accomplished, and what still needs to be done. The assessments are what takes awhile. Anywhere from 2-100 pages depending on the subject, citing suppliers, pricing/availability, alternate techniques, existing systems, technical requirements, etc.

    I work for one of those employers that 'forgets' to do evaluations unless they want to say something bad about you. Real pig **ckers, but until I get off probation, i can't move to another state where there are better jobs.
    Last edited by abachler; 01-04-2008 at 11:16 AM.

Popular pages Recent additions subscribe to a feed

Similar Threads

  1. Seven Kingdoms I: Ancient Adversaries for Linux
    By MIH1406 in forum Projects and Job Recruitment
    Replies: 13
    Last Post: 01-17-2010, 05:03 PM
  2. How do you call another source code file?
    By nifear4 in forum C Programming
    Replies: 2
    Last Post: 10-28-2008, 12:16 PM
  3. DxEngine source code
    By Sang-drax in forum Game Programming
    Replies: 5
    Last Post: 06-26-2003, 05:50 PM
  4. Lines from Unix's source code have been copied into the heart of Linux????
    By zahid in forum A Brief History of Cprogramming.com
    Replies: 13
    Last Post: 05-19-2003, 03:50 PM
  5. Source Code Beautifier
    By Hammer in forum A Brief History of Cprogramming.com
    Replies: 2
    Last Post: 05-05-2002, 09:21 PM