Discussion

Ask HN: How to document your *project*

Hi, I'm looking for online resources of any kind (articles, blogs, threads, even videos!) on how to document a software project.

What I'm looking for are the best practices (even is subjective) on what is considered a good documentation: * How to comment your code? (ok this should be well known :) ) * How to document you architecture? high-level? low-level? * How to document your strategic decisions (two years ago we chose A instead of B because X and Y) * ...

Do you have any resources to share?

9 points dvd0101 8 years ago 7 comments

Discussion

Live from the official Hacker News API

A modern reader for Hacker News · SvelteKit + Skeleton