3 ms·
That's an interesting approach. Generally speaking, my organization doesn't maintain large document repositories because they go stale quickly and our products
by kodah 6y ago
That's an interesting approach. Generally speaking, my organization doesn't maintain large document repositories because they go stale quickly and our products are too vast to document in such a way.
For some context on my reply:
- We maintain one design document per project. This document references everything from the application specifications to the automation that puts it in production.
- Most documentation is written in line with code. Finding documentation is about as complicated as finding the right repository.
This is also why peer review (in our org) isn't limited by level. Ideally we'd get feedback across the experience spectrum to make sure not only code but comments make sense to everyone.
- bluGill 6y agoThat is why step one is review the documentation. If documentation isn't reviewed regularly utility is useless. By using questions as opportunity to review it I can keep it useful.