My boss asked me this recently, and I was all set to give an elaborate answer about evidence based practices, effective use of code snippets, making content searchable, etc. Then I realized—these are just my opinions. I'm wasn't following my own advice. In order to talk authoritatively about what communications developers find effective, I need to ask other developers. So I bring this question to all of you.
Here's the scenario: Imagine you are a junior to mid level developer. A senior developer sends you an email with the subject, "Recomendations for best practices in [your key area of interest]." What would be contained in that document to make it most useful, interesting, and effective for you?
Key thoughts to consider:
- When you read online documentation, how do you decide whether or not to trust it?
- What format(s) are most useful (video, text, images, interactive tutorials?)
- What qualities cause you to dismiss some piece of documentation?
This question is not concerned with client facing and public facing documentation. It is only concerned with internal training tools used within an organization.
Aucun commentaire:
Enregistrer un commentaire