3 ms·
> most codebases lacked a layer describing what the actual use cases of the system were > I've been wondering lately if there is some space in programming lang
by pbourke 5y ago
> most codebases lacked a layer describing what the actual use cases of the system were
> I've been wondering lately if there is some space in programming language design to address these issues.
I think we often over-index on programming language features to solve these issues. A picture is worth a thousand words and a few good words are worth a thousand lines of code. Most internal systems lack even rudimentary documentation that describes the architecture, operation and use cases for it.
Systems in which the designers take the time to write down the way that things are in terms that somehow tie back to the software (function names, class names, etc) would be a vast improvement. The wiki is still an ideal document for this kind of thing - you can link directly to the code from text that discusses it. It’s very helpful to be able to embed diagrams alongside the text as well using a simple graphviz/mermaid style notation.