Documentation - Githubissues

evykassirer / playing-the-internship-game

the rules, tips, and tricks I've learned on how to approach tech internships

https://evykassirer.github.io/playing-the-internship-game/

570 stars 68 forks source link

Documentation #4

Closed rusrushal13 closed 7 years ago

rusrushal13 commented 7 years ago

I am right now attending an internship in Germany and one thing that I am missing that we need to document our work. Can you please explain more on this aspect? (My NDA restrict me to put the work on the Github)

evykassirer commented 7 years ago

to clarify: by documentation do you mean things like commenting your code and writing guides for others to explain how your code works?

rusrushal13 commented 7 years ago

No I meant as every company have non disclosure agreements and due to that we can't talk or upload any codes on Github which are related to work so how to document your internship?

evykassirer commented 7 years ago

Ah, good thing I asked!

So you want to know how to talk about it on your resume even though it's non disclosure?

rusrushal13 commented 7 years ago

Yes 😀

evykassirer commented 7 years ago

A few suggestions on this:

ask your manager/employer - they know what things you can talk about and what things you can't. Hopefully your manager's job is to help your career, so they would be happy to help with your resume and suggest ways to phrase what you did without giving anything secret away
Talk generally about stuff and say whatever you can. Can you say what technology you used? Can you talk about very broadly what team you're on? What your responsibilities were? Did you work with a big team or work individually? Try to find any details about what you're doing that you can share

Does that help? Feel free to followup with any more questions

rusrushal13 commented 7 years ago

How did you manage it?

evykassirer commented 7 years ago

Exactly as I described above

rusrushal13 commented 7 years ago

Thanks Evy 😉