erjand / technical-interviews

A collection of resources for technical interviews.
MIT License
3 stars 0 forks source link

Inconsistent list styles #2

Closed rvorderm closed 2 years ago

rvorderm commented 2 years ago

General Comment / Feedback

Under StudyNotes, you have a mixed bag of bulleted and numbered lists (for the top level). For engineering documents you should almost always use numbered lists over bulleted.

  1. Numbered lists indicate priority. Even when you don't think one item is more important than another, it often is, and this is generally still a persuasive document, albiet one using logic and data.
  2. It's easier to refer to numbers. In fact if you want to call out an item under Key Rules, you would have to refer to "the third bullet" so it's already implicitly numbered. With numbered lists you won't have to count bullet marks.
  3. Bulleted lists are best for managerial documents, and limited to 3-4 items, things that tend to be vague and actually are all equivalent, like guiding principals.
rvorderm commented 2 years ago

Also, the open check boxes are best utilized for workflows where you need to indicate progress, or assigning attributes. For example in this list:

Affected sections:

  1. Big O
  2. Data Structure
  3. Algorithms