Re:Ask HN: How does your team do internal documentation?
by GFischer on Friday September 09, 2016 @02:47PM
(#12465013)
I agree with your points. Tech isn't the key, but it's definitely an enabler.
Some key features for a good documentation system IMO are :
- that it has to be frictionless both to add information and to use it (and Sharepoint isn't), - someone has to stay on top of it (that's the most important thing IMO), - and information has to be easy to look up (another Sharepoint failing).
Word files on a file system, with something to make it searchable, would be pretty decent for a few users (too bad Google Desktop Search has been discontinued). For multiple users or sites, concurrency and versioning will probably be a problem.
Sadly, many companies get carried away with security concerns and end up with less than optimal solutions.
I guess that's why people like Git whatever for it.
Before that we used Word files and the network's file system, which worked better than Sharepoint.
I don't think the technology is the key to keeping documentation relevant.
Ultimately there needs to be a policy of how to keep documentation up to date and in order AND someone needs to make sure the policy is followed.
Documentation is a balance between keeping it useful and not being so detailed that it's hard to maintain.