software-development-lessons

Taking Notes (like a developer)

This lesson goes over taking notes with markdown

Slides

Topics

• Markdown
• Git

Taking Notes And Writing Like A Developer

• Many ways to keep notes and write about code. This is how I do it.
• Create a Workspace/notes directory for daily notes
• Open notes/ folder in vscode
• Create a markdown file *.md for todays notes
  • TIL
  • TODOs
  • links
  • meeting notes
  • timesheet / schedule
  • etc.

Why?

• Need a place to track your learning, links, meeting notes, schedule, todos, etc.
• README and technical documentation are often written in markdown
• Piazza, Slack, GitHub, StackOverflow and many other websites support markdown

Markdown

• Any file ending in *.md or *.markdown
• VSCode automagically supports markdown
  • command + shift + v to view markdown preview in VSCode

Heading

# H1
## H2
### H3

List

* First item
* ~~Second item~~
* Third item

Link

[Google](https://google.com)

Code

<!-- 1 liner -->
`<h1>Hello World</h1>`

<!-- multi line -->
```ruby
def my_method
  puts 'Hello'
end

Example Notes

# time
* 830-915 worked on treehouse hashes
* 915-930 stand up
* 930-1030 linkedin profile peer review

# links
https://www.markdownguide.org/cheat-sheet/


# todo
* ~~finish treehouse hashes~~
* update linkedin profile
* add linkedin link to my github.io page

Resources

Cheatsheet Try out markdown online Markdown Essentials

Next Up

Data Modeling - Very Best