3 ms·
The problem with documentation is that it's an untracked dependency with a slow, manual test procedure. An almost universal example of this is developer onboard
by simpaticoder 3y ago
The problem with documentation is that it's an untracked dependency with a slow, manual test procedure. An almost universal example of this is developer onboarding materials that are always (always!) out-of-date. In fact, most teams expect new devs to update the docs as part of their first tasks! (I think this is, in part, to measure a) their ability to deal with bad advice, and b) their willingness to make things easier for those that come after.)
It would be great to invalidate documentation when the underlying code changes. There would be two levels of invalidation differentiated by probability: "these docs are definitely wrong now" and "these docs may be wrong and need to be checked." This is easier with APIs than with UIs but I've not seen it done with either. Some motion in this direction are, for example, IntelliJ's comprehensive refactoring support that can and will search documentation.
I'm not really sure what a good solution looks like, but there's definitely a chunky problem to be solved here.
- euroderf 3y agoWhen features changed, I marked the associated documentation as "Preliminary", visibly indicating incompleteness. This marker was not sufficiently embarrassing to get developer time for documentation.
- euroderf 3y ago> a slow, manual test procedure End-users (i.e. documentation readers) are inevitably the last line of proofreading and docu-debugging. A nice idea I've seen is to put a "comment on this page" button tucked away in the corner of EVERY page.