DEV Community

Discussion on: 08 Mistakes to avoid As a Programmer

Collapse
 
codinglanguages profile image
Your DevOps Guy

Bonus Tip: Try to maintain one error doc so that you can refer it whenever you encountered that error again.

I like this tip a lot! I mentioned in one of my articles about coding interviews, but you can apply it to other contexts.

I just found one I wrote while I worked at Amazon. Iยดll share it soon.

Thanks for sharing!

Collapse
 
nagkumar profile image
Raja Nagendra Kumar • Edited

Better not a self-document, but file it as ask for the inputs @ stack trace and suggest the solution too. It is easy to refer anytime, anywhere, build a reputation and you have global developers' attention too.

I also love error be properly put as JIRA issue(s), it helps as a stronger reference as long as you are in that company.

Collapse
 
designerakash profile image
Akash Upadhyay

Thank you for sharing your opinions๐Ÿ’š๐Ÿ˜€.. And I think it's great if we can start documenting what we are doing daily.. it's a good habit.. It's very useful for us and we also find it easy we start doing documentain in the company ๐Ÿ˜€๐Ÿ’š

Thread Thread
 
nagkumar profile image
Raja Nagendra Kumar

When you say documentation, is it word doc, Evernote, etc or are u referring to any good developer tooling like JIRA etc.?

Collapse
 
designerakash profile image
Akash Upadhyay • Edited

I'm glad that you find it useful ๐Ÿ˜€๐Ÿ’š.. Sure I can wait for ur version

Collapse
 
darkwiiplayer profile image
๐’ŽWii ๐Ÿณ๏ธโ€โšง๏ธ • Edited

Either that or use git. If you fix a bug, be sure to add a good description of the bug in the commit message; then, in the future, you can just use git log --grep "<error message>" to look through the commit history and find all the relevant information, including how it was fixed back then, who did the fixing (and might therefore know more about it), when that was, etc.

Collapse
 
designerakash profile image
Akash Upadhyay

Yes, your right.. Both r the good option to have but to have is the first step and the important step to maintain the documentation for errors๐Ÿ’š๐Ÿ˜€.. Thank you for sharing your experience...