Style Guide for Notes

Flesh out the idea with simple paragraphs, and rely on organic linking of concepts.

General

• content doesn't have to rely on earlier information
• capitalize all nouns, pronouns, verbs, adjectives, adverbs, and subordinating conjunctions.

Formatting

• bold for keywords and concepts
• italics for emphasis
• underline for notes, warnings and cautions

verbatim

• product names (Node.js, GCC)
• concept names (Immediately-Invoked Function Expression)
• file names (.emacs.el), file types, file ...
• commands, and shortcuts (C-x C-e)
• package names, from a human perspective (Org Mode, but not org-mode)

code

• code snippets
• compilers and interpreters (gcc, not GCC)
• class, object, function, variable name
• package names, from a system perspective (org-mode, not Org Mode)
• shell commands (ls)

For longer snippets, just use the code block

cd ~
pwd

The filetags

:source/{name_ofsource}:

literature notes

:ever/seed:

notes with a couple of sentences or a plain link

:ever/sapling:

notes where I fleshed out more of the content

:ever/green:

frequently used notes, complete understanding

:ever/weed:

notes which need work

:ever/sprout: (default)

notes that require deeper understanding of the topic, unclassified, the amount of notes with this tag should be limited to prevent context switching

References or Metadata (optional)