TE
TechEcho
Home24h TopNewestBestAskShowJobs
GitHubTwitter
Home

TechEcho

A tech news platform built with Next.js, providing global tech news and discussions.

GitHubTwitter

Home

HomeNewestBestAskShowJobs

Resources

HackerNews APIOriginal HackerNewsNext.js

© 2025 TechEcho. All rights reserved.

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

2 pointsby alando46over 1 year ago
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

syndicatedjellyover 1 year ago
&quot;Documentation as code&quot; is a nice idea<p>Architecture diagrams that can be versioned-controlled using the same VCS as code is a great idea. I&#x27;ve grown fond of mermaid.js recently (it renders natively in GitHub)
warrenmover 1 year ago
&quot;document&quot;?<p>You <i>MUST</i> be new here :P<p>Sadly, documentation gets relegated so far down the list of priorities that it [effectively] never happens :|
thfuranover 1 year ago
I usually create a backlogged task for adding some documentation.