Questions tagged [documentation]

The tag has no usage guidance.

Filter by
Sorted by
Tagged with
1
vote
4answers
605 views

How can I encourage structured knowledge sharing in my team?

I work in a six person team and I am the only remote team member. I have been in this job for almost a year and I find the remoteness to be an extremely difficult factor in domain knowledge ...
1
vote
3answers
449 views

Documentation - is it an assumed part of the job? [closed]

So I was told from higher-ups that a software engineer that left the company didn't document his processes and he should have as part of his duties. My gut reaction was to say - "you don't get what ...
43
votes
7answers
19k views

My employer wants me to write a guide for doing my job

I'm on my way out of a company doing tech work for an SMB (Small or Medium-sized Business) and I happen to be the only expert on various parts of the company's operation. I gained this knowledge ...
24
votes
4answers
1k views

Ethical concerns when discussing technical issues related to my work, on my personal blog

When I fix issues, some of them are company specific so I try to document them internally. Others are broad and can be applicable to any one. I try to document them in my own blog. I am wondering if ...
14
votes
7answers
1k views

Is it tactful to get in touch with a previous developer?

I'm in the position where I have inherited a highly complex codebase predominantly written by developers who have since separated from the company. I am not aware of what circumstances they separated ...
0
votes
2answers
597 views

Poor documentation culture [duplicate]

I work in a production company as a design engineer. There is a culture in my company of not documenting things, there are few standards, barely any routines and no documentation system. There is a ...
-4
votes
1answer
1k views

How to document ongoing harassment in a professional way? [closed]

While writing detailed documentation about harassment I'm experiencing, what's the best way to keep it professional without losing its emphasis? For example, my manager called me on Skype and said "I ...