Key note categories and examples for tech issues

I’m currently working on making video tutorials but I thought it would be nice to share this article that I’ve written for one of the tutorials, which has example notes for key issue categories.
I sent a newsletter to the users but let me share it here as well!


As we discussed on this page, Inkdrop has an opinionated note-taking workflow that encourages you to focus on writing one note per issue, while managing them as tasks with note statuses.
This workflow would help you effectively build your knowledge base while keeping track of your progress and tasks. However, if you are new to software engineering, it might still be unclear what kind of issues or information you should document. So, this guide aims to clarify when and what to write, with real-world example notes across 9 key issue categories:

  1. Small projects
  2. Bugs
  3. Feature ideas
  4. Learning tasks
  5. Research topics
  6. Troubleshooting issues
  7. Configurations and tips
  8. Performance optimization
  9. Operation procedures/logs

Continue reading on the documentation website here:

I hope it’s helpful for your tech note-taking :dash:

2 Likes