3 ms·
Well-defined and well-documented are usually orthogonal properties. You hit the nail on the head with mention of contracts. We need wider adoption of tooling
by drewcoo 5y ago
Well-defined and well-documented are usually orthogonal properties.
You hit the nail on the head with mention of contracts.
We need wider adoption of tooling like Pact. (Ironic link to Pact docs follows.)
https://docs.pact.io https://docs.pact.io
- layer8 5y agoWell, if it’s well-defined but not documented, then you can’t tell the definition and can’t judge wether it is well-defined. If it’s documented but not well-defined, then that means that the documentation is incomplete (there is “undefined” behavior) and/or inconsistent. Having a complete and consistent definition (which is what I would call “well-defined”) is almost the same as having a complete (describes all behaviors) and correct (the actual behaviors match the documented behaviors) documentation.