3 ms·
I disagree with this (sort of) for a couple of reasons: 1. For one, I think it's hard enough just to keep technical documentation up to date. Keeping separate
by hn_throwaway_99 5y ago
I disagree with this (sort of) for a couple of reasons:
1. For one, I think it's hard enough just to keep technical documentation up to date. Keeping separate business process docs up to date with code feels like it would be a collosal task.
2. That said, most software at least starts with some amount of requirements (whether that be a formal spec or a bunch of Jira epics). I have rarely seen any engineer start first by reading all of the old business requirements before trying to understand the code.
3. Even if the business requirements were documented perfectly, I rarely find that they are the major issue with understanding a code base.
- talaketu 5y agoBusiness data / process flow is so stable compared to a software implementation that having quality documentation pays dividends again and again. If you could document only one thing, document the business data flow.
- giantg2 5y agoSome industries are subject to control audits. So documenting the processes serves two purposes. If the business doesn't know their process well enough to document or explain it, don't you think there will be water effort and rework, especially for edge cases?
- remoquete 5y agoIt’s not a colossal task if you hire technical writers.