Jeffry Brickley's avatar image.

My name is Jeffry Brickley, I did it backwards. Career first, now back for degree..

Anonymous profile image
  • Need help. At my internship, I was confronted by my manager who says I need to document my code more.

    Because of this, I feel like I am lower on the ‘pole’ than the other interns. How to get back on the right track?

    Jeffry Brickley's avatar image.

    I'll take it one step farther than the others. I agree it's not a bad thing to be told what to improve. You take the application and improve it. Generally this means that the manager likes your work and wants you to improve.

    When you get no feedback, that's rough. Are you doing so great that there is no fault at all in your work? or are you so low on the totem pole that the boss no longer cares what you do, he just wants the summer to end.... bad... bad...

    Take the advice given and improve in that area. Documentation is *THE* most common place to improve for most of the field of software engineering. Fixing it now, as an intern, makes you many times more valuable later as an employee. Not fixing it just makes you average. As an intern you don't want to be average, as a prospect employee after your internship, you don't want to be average.

    Anonymous profile image
    Anonymous

    Wow awesome advice Jeffry, thanks. If documentation is the most common place to improve, why do you think there is such a strong emphasis on the actual code itself and not the 'shareability' of it? I was always scored minimally on my documentation.

    What are some common documentation mistakes that you see?