DEV Community

Discussion on: The Importance Of Documentation

Collapse
 
dimitrim profile image
Dimitri Mostrey

Thanks for reminding us to the importance of documentation. Another possible bulletpoint is: Reminding ourselves how the code works.

We probably went all through the painful process of re-opening a project of years ago. Unless you have an elephant memory it goes like Did I write this? Never mind finding the bug or the insight to update or add new features.

We learn. We improve. Languages evolve. New techniques/frameworks. We outwit ourselves at times. Even international acknowledged standards change (may/must/should/...).

To the point of embarrassment of What the heck was I thinking? I guess it's normal. So I started documenting code... for myself. At first.

Last but not least. What happens if you sell a project/website? My guess is, a well documented (private) project augments the value thereof.

Collapse
 
olibhiaghosh profile image
Olibhia Ghosh

Thanks for sharing your POV !!