How does everyone feel about documenting your code and projects. Is it necessary for companies? Do you like it or is it busywork?
For further actions, you may consider blocking this person and/or reporting abuse
How does everyone feel about documenting your code and projects. Is it necessary for companies? Do you like it or is it busywork?
For further actions, you may consider blocking this person and/or reporting abuse
Scofield Idehen -
Jon Snow -
Ben Halpern -
April Edwards -
Once suspended, avbisme will not be able to comment or publish posts until their suspension is removed.
Once unsuspended, avbisme will be able to comment and publish posts again.
Once unpublished, all posts by avbisme will become hidden and only accessible to themselves.
If avbisme is not suspended, they can still re-publish their posts from their dashboard.
Once unpublished, this post will become invisible to the public and only accessible to avb-is-me.
They can still re-publish the post if they are not suspended.
Thanks for keeping DEV Community safe. Here is what you can do to flag avbisme:
Unflagging avbisme will restore default visibility to their posts.
Top comments (7)
I love writing documentation. Because it helps me test and validate my ability to explain what I wrote.
I was the same (retired from commercial work now though!). First explain it like I'm 5, then you know your understanding is good enough to write the tests, then write the code to pass the tests...
What kind of things are you writing documentation for? I can't really recall writing much in the way of documentation at all over more than 25 years developing professionally - in the smallest, right up to large companies.
I'm not just being devil's advocate here... I'm genuinely curious
Just more curious to get a sense of how folks feel about documentation. My assumption it is something we all have to do, but I am wondering if my assumption is wrong.
I don't like writing technical documentation. The thing is, I like debugging and guesswork even less.
As for functional documentation, you basically have two options.
I find writing docs less tedious since I started blogging though. There are plenty of tools that make it very simple. Especially software like JSDoc, Docusaurus and Obsidian.
I think it's really important write the right documentation. I think self explaining code is a myth If you go beyond simple tutorials or basic scripts. That beeing said my opinion in how to document best is still forming.
Documentation in general and documentation of the code is kinda different to me.
For a project it actually can be very important and for code it depends on what you want to document, because if it is about explaining what the code does, I would try to avoid doing it.