Ask HN: Is there a better way to document complex software architectures?

Re:Ask HN: Is there a better way to document complex softwar... by derangedHorse on Sunday November 25, 2018 @06:13PM (#18529713)

There's also the reason of not wanting to generate all the code every single time someone new retrieves the repo or needs to revert back to a previous commit.

[ Parent | on HN ]

Re:Ask HN: Is there a better way to document complex softwar... by taeric on Monday November 26, 2018 @06:01AM (#18532458)

This reason doesn't make sense. Again, do you checkin the bytecode of your java? I'd expect you, instead, to recompile the java every time you do a build.

Now, I would expect you to have an artifact repository. To that end, you would be able to easily get the generated sources. But, they would decidedly not be in the source repository.

[ Parent | on HN ]

Re:Ask HN: Is there a better way to document complex softwar... by jonathanlydall on Monday November 26, 2018 @06:28AM (#18532561)

I don't feel the bytecode comparison makes sense, because the generated code is human readable, bytecode is (to almost all intents and purposes) not.

We feel that code generation is something one does explicitly while modelling, not something done every time you build.

[ Parent | on HN ]

Re:Ask HN: Is there a better way to document complex softwar... by jonathanlydall on Monday November 26, 2018 @06:23AM (#18532541)

Completely our thinking too. Code generation should not be a build or run time dependency.

Our tool also allows developers to review proposed code changes before choosing to commit them to disk.

Code generation is something you choose to do explicitly as you model.

[ Parent | on HN ]