3 ms·
Counterpoint: this can only work if your company has a culture of reading first. I spent a lot of time on an exhaustive readme, but at best people skim it and
by Cthulhu_ 5y ago
Counterpoint: this can only work if your company has a culture of reading first.
I spent a lot of time on an exhaustive readme, but at best people skim it and ask questions or make the same mistakes I made again.
Writing is cool and all, but make sure you have a system in place, an index, and a culture of telling people where to find what.
- westoncb 5y agoWhen I'm working with someone new I pay attention to their writing for a while to see how much effort/attention to detail they put into it, and then basically match. It's the best heuristic I know for not wasting effort on writing since typically someone rushing through writing will do the same with reading. Always a pleasant experience meeting new co-workers who care about writing though.
- polote 5y agoIt is more a culture of searching then. Joking aside. Culture of writing usually includes the fact that people search by themselves for information and that information is stored in a central place. Otherwise we would call the Slack threads culture a culture of writing too. The expression culture of writing is badly chosen for the tech world
- grogenaut 5y agoGreatly agreed this is a better way to think about it. Self service documentation is definitely one way. Writing great documentation to help others come up to speed. But you also need a culture of actually looking for answers in documentation yourself. Also realize that some people don't learn that way. I made trainings in video and wiki form for a group a started, I did the same documentation in a video. For 70% of the people in my group the video clicked better. They use the wiki more as a rubric. So having both works well, however the video was quite time intensive to make. Another way is what people talk about for Amazon, which you may be referring to. While plenty of communication happens verbally or in hallways, the important communication happens in writing and then discussion of that writing. And you are correct it is all about a culture of reading to understand that idea. And then writing again to update it.