Good code documentation

Good code is its own best documentation but in some situations we should write documentation :

👉Document new code thoroughly.
👉Explain how features operate.
👉Detail API/library usage.
👉Clarify configuration options.
👉List required dependencies.
👉Provide practical examples.
👉Address unusual scenarios.
👉Outline contribution guidelines.

How to write it ?

✅ Use simple language and avoid technical jargon when possible.

✅Explain the purpose of the code/module/function.

✅ Provide examples of how to use the code with different scenarios.

✅ Detail each parameter and its expected type and behavior.

✅Clarify what the function returns and under what conditions.

✅ Document any special cases or edge conditions.

✅List any dependencies required to use the code.

✅ Mention compatibility with different platforms or versions.

✅Provide insights into the performance characteristics of the code.

✅Describe how errors are handled within the code.

✅Explain how others can contribute to and improve the code.

✅ Document any recent updates or changes to the codebase.