Tags
meta
This note contains a collection of tags that will be shared by all notes. The aim of this note is to provide a consistent naming convention for all notes across the cauldron.
Guidelines
- Use singular nouns wherever possible.
- Use plural nouns when the document is a collection of similar items.
- Let the tag be an answer to “What is this document about?”
- Always begin with the coarsest tag and then add finer tags. To be more specific, follow this sequence:
<core topic tag>, for example, linear algebra<sub topic tag>, for example, matrix factorization<sub-sub topic tag>, for example, eigendecomposition
<course tag><note tag><state tag>
- Whenever a new tag is discovered, add it to this list.
State tag
Each note should pass through three stages:
- draft: currently working on the note and it is only a draft at this stage
- review: a note is under review if the draft is ready and is ready to be proofread
- publish: a note is published if it is deemed complete
A published note may still undergo emendations.