Ask HN: How do you document SW projects at your company?

2 points by alando46 2 years ago | 3 comments

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?

syndicatedjelly 2 years ago |

"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)

warrenm 2 years ago |

"document"?

You MUST be new here :P

Sadly, documentation gets relegated so far down the list of priorities that it [effectively] never happens :|

thfuran 2 years ago |

I usually create a backlogged task for adding some documentation.