3 ms·
It took us forever, and it's still (and probably always will be) a work in progress. But a couple key points for us: - We established a single wiki for our dep
by castillar76 8y ago
It took us forever, and it's still (and probably always will be) a work in progress. But a couple key points for us:
- We established a single wiki for our department, and gave teams control of their own spaces. One wiki in one place with full-text search means that if the document exists, you can at least find it.
- We followed that with an organizational mantra: "If it doesn't exist in the wiki, it doesn't exist at all". If you have any kind of docs, they go in the wiki. Crucial to success here was using wiki software that would take Word docs, Excel spreadsheets, graphics, etc. and just attach them to pages and optionally render them. (We used Atlassian Confluence, but YMMV.) This meant that if you had the docs, there was as small as possible an effort involved in placing those in the wiki where others could find them.
- Periodically, we have Friday 'wiki burn-down days', where we buy pizza for the group, huddle in a conference room, and spend the day in the wiki. We write articles, we clean up spaces, we fix up documentation.
- We experimented with having new engineers work with senior ones to write documentation. This was OK in some regards--it did help them be exposed to more things, and encouraged more senior folks to explain things and answer questions to write the articles. But it definitely takes time, and wasn't as useful as an onboarding exercise as we would have liked—depended a lot on how well the senior person could explain it, and how well the junior person knew to ask questions about it.