News for hackers. Stuff that matters.

A comment on Theory-building and why employee churn is lethal to software companies. Parent comment

Re:Theory-building and why employee churn is lethal to softw... by smaddox on Tuesday January 10, 2023 @06:11PM (#34332809)
Yeah, I've found the C4 model helpful for finding the appropriate level of abstraction for architecture documentation: https://c4model.com/

Code documentation, in contrast, should be auto-generated from the code.

[ Parent | on HN ]
Re:Theory-building and why employee churn is lethal to softw... by StarlaAtNight on Tuesday January 10, 2023 @10:51PM (#34334823)
Can you auto-generate the description of a function in a Python docstring from the code?

But yeah, totally into auto-generated (great example is dbt’s docs command: https://docs.getdbt.com/docs/collaborate/documentation)

[ Parent | on HN ]