3 ms·
I'm really impressed with the readme file in this repository. Its a master class in effective documentation. Just look at the structure: - 1-2 sentence summary
by josephg 4y ago
I'm really impressed with the readme file in this repository. Its a master class in effective documentation. Just look at the structure:
- 1-2 sentence summary of the project
- History (why we built this and didn't just use existing tools)
- What we've built, including what it does and how it compares to other tools (rsync in this case).
- How to install and use it
And the whole thing is full of images and animations showing the tool in action, and explaining enough of its internals.
I consider myself good at documentation, but I'm taking notes. This is excellent.
- SV_BubbleTime 4y agoIt’s always amazing to me how little emphasis people give to INTENT on their repo.
- deleted 4y ago[deleted]
- hot_gril 4y agoThis is how I strive to document things. Focus primarily on what the tool is used for and why, not trying to define what it is.
- aembleton 4y agoAlso for commit messages - why the change is made, not what it is.
- zmmmmm 4y agoThe documentation in the code itself is pretty great as well: https://github.com/google/cdc-file-transfer/blob/main/fastcdc/fastcdc.h#L59 https://github.com/google/cdc-file-transfer/blob/main/fastcd...