DEV Community

Discussion on: Lessons Learned After Two Years of Being an Engineer

Collapse
 
courier10pt profile image
Bob van Hoove • Edited

Much agreed, taking notes is very helpful. Especially when you have not been working on an issue for a while, or when you have to revisit it.

I use docs/{project}/{issue} folders. They contain things like:

  • notes.md: a plaintext document elaborating on / exploring the issue
  • some sql scripts that were used
  • diagrams / flowcharts / ..
  • files submitted with the issue, like excel sheets
  • A list of reference material I used, which usually resides in notes.md

I have a sublimetext project pointing to the docs folder. For now it's mighty fine. At some point I may have to start archiving things :)