Thoughts on the importance of documentation.

Saves Time

A routine, class, or dependency in the codebase could help you with the current task. But you have to go on a treasure hunt without documentation.

Easier To Navigate

With documentation, you can find your way easily in the code. You can observe this in any popular framework. 

Speed Up Development

AI can suggest code blocks and snippets. But without documentation, even LLMs have to take time. And they might suggest incorrect code.

Documentation is your friend if you want other collaborators in your team to onboard or keep up with the speed.

Great DX

Many frameworks and libraries went extinct because of poor developer experience. Documentation offers a great DX that makes the developer’s lives easier.

How To Improve Your Docs?

Do not wait until the last minute to create or update your docs. 

Add documentation as part of your workflow.

Every PR should update the docs accordingly.

Start with a simple README file and then improve it.

Follow the coding standards of your programming language, framework or project.

In short, could you do yourself a favour and document it?

Prompt:
Image of a web developer writing documentation. Realistic, indoors, natural light