Documentation
rusrushal13 opened this issue · 8 comments
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)
to clarify: by documentation do you mean things like commenting your code and writing guides for others to explain how your code works?
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?
Ah, good thing I asked!
So you want to know how to talk about it on your resume even though it's non disclosure?
Yes 😀
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
How did you manage it?
Exactly as I described above
Thanks Evy 😉