4 ms·
> You should try to have a single source of truth as much as possible. If you have many places where information can be found, it will affect both people writin
by sqs 6y ago
> You should try to have a single source of truth as much as possible. If you have many places where information can be found, it will affect both people writing the documentation and those trying to find it. The writers will have yet another blocker to just getting stuff written down. The readers won’t know where to look and will have to interrupt people in Slack, as opposed to referring to the knowledge base themselves.
Agree x1000 with this point, with emphasis on the point about readers. The probability that someone will write down an important piece of information (and will do it well) is proportional to their perception of the benefit from doing so. If the would-be author thinks nobody would read it, they won't write it down in the first place. If they think team members will find it and read it 1,000 times in the next 3 months, then they're very likely to write it down.
> I believe it has to be easy for people to write a document without having to worry too much about where to put it. Therefore, I believe it's better to have a tool with good search functionality rather than investing in having a perfect information architecture. In the latter case, we're putting up extra roadblocks for the writer, because then they'll need to spend extra time figuring out where to put their writing in the first place.
To make this work, I think you need to designate certain documents and locations as sources of truth. If any random Google Doc that someone drafts can be considered a source of truth, then gathering the "canonical" information about any topic ("what's all the customer feedback from Acme Corp?") becomes extremely difficult, especially to newer team members who haven't fully internalized the communication practices yet.
Here's our handbook page that describes what has worked for us (at Sourcegraph): https://about.sourcegraph.com/handbook/communication#sources-of-truth https://about.sourcegraph.com/handbook/communication#sources.... Only very specific Google Docs are sources of truth; all others are just ephemeral scratchpads.
- Koshkin 6y ago> a single source of truth Naturally, these have been called "bibles": Unix Bible, Linux Bible, Linux Command Line and Shell Scripting Bible, etc.