recommendations for creating documentation
Dear community, a colleague who is studying while she is also working for my company has recently created a documentation for users. In my role as a coach for trainees and students, I supported her on this topic.
After she was done with the documentation, I asked her if she could compile her experiences as general recommendations on the topic of “creating documentation”. And then share them with her colleagues who are also in training or studying. Because the task of writing documentation occurs in everyday developer life. Sometimes it’s documentation for users, sometimes it’s a requirement, sometimes it’s an error that has to be documented.
She was happy to do that and I think, all in all she did that very well. That’s why I talked with her boss so that we were allowed to publish these recommendations – perhaps trainees in other companies will benefit, too?
Best regards and please stay healthy