Documentation

Creator

Creator

Alan Jo

Created

Created

2023 Oct 10 11:59

Editor

Editor

Alan Jo

Edited

Edited

2024 Mar 27 2:54

Refs

Refs

Service Planning

Documentation Usages

Documentation Tool

Two open source projects with great documentation

esbuild and Redis1 are two examples of codebases with exceptional documentation. Through their READMEs, changelogs, architecture documents, and code comments, both projects explain their design in such a way that someone new to the codebase can understand where things are, how things are done, and why they are done that way. If you’re a developer looking to get better at documenting your code and software architecture, these are great case studies.

Two open source projects with great documentation

https://johnjago.com/great-docs/

Two open source projects with great documentation

How to add documentation to your product life cycle

An evaluation of different processes used to create documentation, and their advantages and disadvantages for the organization, the customer, and the writer.

How to add documentation to your product life cycle

https://thisisimportant.net/posts/process-models-for-documentation

How to add documentation to your product life cycle

Should you add screenshots to documentation?

Screenshots in documentation can be a contentious topic — some people really like them and think they add a lot of value, while others dislike them due to the maintenance burden and accessibility issues. So what should you do?

Should you add screenshots to documentation?

https://thisisimportant.net/posts/screenshots-in-documentation/

Should you add screenshots to documentation?

Take the Road Most Documented

How great would it be if the solution to most errors you face were in the first place you looked? That’s what the Arch Wiki has been for me: a massive wealth of information and troubleshooting resources to help me navigate the various configuration and installation issues I’ve encountered. Some people claim Arch Linux is too difficult for new users, but for me it’s been the only distribution I’ve been able to get consistently working, and it’s all thanks to the detailed documentation and known workarounds.

Take the Road Most Documented

https://jarbus.net/blog/take-the-road-most-documented/

Recommendations

//