markmanuelmiller / anki

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Anki Decks for Software Engineering

For general information on Anki, checkout this YouTube video.

Getting Started

  1. Download Anki here - it's free!

  2. Install the "CrowdAnki" add-on here. For information on installing add-ons, checkout this guide.

  3. Restart Anki - this step is important - you must restart Anki for the add-ons to take effect.

  4. Clone this repository to your local machine.

  5. Using Anki, click "File" > "CrowdAnki: Import from disk" option and select a folder in this repo. Important: each folder in this repo represents a deck in Anki, so you'll need to perform this action for each deck you wish to import.

Methodology

When to create a new deck?

For Anki and its algorithm to work the best, we want to limit the number of decks we create. But at the same time, we don't want to put specific technologies like Kafka or JavaScript, into a general software engineering deck, so we've created standalone decks for those.

When contributing, please try to place general software engineering questions in the "Software Engineering" deck. If you have tech specific cards, feel free to create a new deck!

Examples

  • Security/authentication cards would go in the Software Engineering deck
  • Promises in JavaScript cards would go in the JavaScript deck
  • CAP Theorem cards would go in the Software Engineering deck
  • React's virtual DOM cards would go in a new React deck.

Contributing

If you're interested in contributing (and you should! the power is in community contribution) there are a few things to keep in mind.

  1. Try to minimize the context required for a certain card. Make sure the card's question/front/text makes sense to someone seeing it for the first time.
  2. Refrain from copy/pasting large chunks of text into one card. Follow the KISS principle with cards.

Process

  1. Within the cloned repo, create a new branch (example branch names: "new-deck-react" or "updating-deck-javascript").
  2. Using Anki, click the gear icon next to the deck you wish to update and click the "Export" button.
  3. Select "CrowdAnki JSON representation" as the export format.
  4. Click export and select the location of the repo.
  5. Create a pull request with the updated files.

About

License:MIT License