4 ms·
Well, maybe documenting everything is good, but what's more important is to make sure that the documentation is properly organized, which is exactly what OP is
by andreygrehov 9y ago
Well, maybe documenting everything is good, but what's more important is to make sure that the documentation is properly organized, which is exactly what OP is asking about. I've seen many wikis/confluences with multiple documents per topic, i.e. the author of the second document didn't know that the first one existed at all. In such cases, company wikis get cumbersome as they are polluted with knowledge.
I would say that the culture + making sure your projects and teams are well organized is the key to success. In addition, I'd recommend to follow some protocol when documenting things. This will make both writing and reading a less intense and more predictable task, resulting to a better overall experience.
- godelmachine 9y agoOnly for the sake of emphasizing your point, I have seen companies go out of business only because they did not follow proper documentation procedures.
- SeaDude 9y agoWhats funny, is you must also be careful what you document as it becomes discoverable. Even procedures, especially when they are safety sensitive, involve the public, or anything sorbanes.
- godelmachine 9y agoThat's a nice suggestion, but I don't get what is meant by "sorbanes"? Are you referring to Sarbanes–Oxley Act of 2002?