Note Taking Best Practices

This document describes my note taking best practices and conventions:

Note naming conventions

Overview of conventions which will make navigation through the data faster.

ABBREV: phrase | phrase.cz

Convention:

• synonyms for a phrase

Example:

• Feature | Variable | Příznak
• ML: Machine Learning | Strojové učení

ABBREV: expanded abbreviation

Convention:

• ABBREVIATION: Expanded abbreviation
• autolinking is aware of this convention in both ABBREVATION and expanded abbreviation are considered to be links

Example:

• NLTK: Natural Language ToolKit

phrase >>>

Convention:

• phrase >>> is Link to the actual content i.e. another Note or Notebook

This is convention for link which can be easily distinguished in search and list.

Example:

• Docker >>> is name of the Note which links to Docker where is actual content
• Docker is the name of the Note with content.

[phrase] description

Convention:

• Use it whenever you do not want to be prefix interpreted as abbreviation.
• Useful when finding Notebook/Note by name to faster find out the context in which is the term used.
• Hints:
  • It's like [group] Subject in newsgroup

Examples:

• [Docker] Tips and tricks

{phrase} find usage for this convention

Convention for which I don't have meaning yet - propose it for MindForger!

(phrase) find usage for this convention

Convention for which I don't have meaning yet - propose it for MindForger!

@phrase

Convention for which I don't have meaning yet - propose it for MindForger!

Note emoji prefixes convention

I use the following emojis as prefix of Note names:

• 🎯🚀🧪🌟🔧🐞📄🗑👁️

I use the following convention:

• goal: 🎯
• feature: 🚀
• enhancement: 🌟
• fix: 🔧
• bug: 🐞
• test: 🧪
• doc: 📄

🎯 goal

🚀 feature

🧪 test | experiment

🌟 enhancement

🔧 fix

🐞 bug

📄 doc

🗑 removal

👁️review