Comment by smeej
2 years ago
Then the challenge becomes recording where each thing is recorded so that when it needs to be updated, you update it everywhere and don't end up with conflicting documentation.
2 years ago
Then the challenge becomes recording where each thing is recorded so that when it needs to be updated, you update it everywhere and don't end up with conflicting documentation.
This. Repeating information is helpful. repeated information that became inaccurate isn't. It's a difficult line to balance
Someone will trip on the mistake and report the bug and you fix it.
You dont get a compile error if the documentation is wrong. Chances are you wont notice.
And even if it eventually is fixed it is not obvious that the reason for the bug was that the documentation was wrong in one particular place.
1 reply →