Ask HN: How do you document SW projects at your company?
Doing some research to see if there is a better way to document software projects given detailed design docs are usually: 1. out of date basically immediately, 2. hard to update and keep in sync with the latest project developments. Have you encountered any approaches along your career that you favor for addressing these issues?
3 comments
"Documentation as code" is a nice idea
Architecture diagrams that can be versioned-controlled using the same VCS as code is a great idea. I've grown fond of mermaid.js recently (it renders natively in GitHub)
Architecture diagrams that can be versioned-controlled using the same VCS as code is a great idea. I've grown fond of mermaid.js recently (it renders natively in GitHub)
"document"?
You MUST be new here :P
Sadly, documentation gets relegated so far down the list of priorities that it [effectively] never happens :|
You MUST be new here :P
Sadly, documentation gets relegated so far down the list of priorities that it [effectively] never happens :|
I usually create a backlogged task for adding some documentation.