Prendere appunti con Markdown e GitHub

Come ho creato un semplice repository per prendere appunti usando Markdown e GitHub.

Ho capito, sei stufo delle migliaia di video di YouTube e post di blog su come prendere appunti. Anche io! Così ho deciso di andare al sodo e costruire il mio sistema per prendere appunti, il più semplice possibile, senza BS.

Nozione ? Sì, sembra incredibile, ma non ho tempo per scalare quella ripida curva di apprendimento.

Praticamente qualsiasi app mobile per prendere appunti? Potrebbe essere, ma voglio essere in grado di cercare rapidamente informazioni mentre lavoro, ridurre al minimo il cambio di contesto e, si spera, tenere le mani sulla tastiera mentre ci sono.

Un semplice file di testo? Forse un po' troppo estremo, sì è semplice e non richiede manutenzione, ma voglio che i miei appunti siano leggibili, e d'altra parte non voglio perdere tempo a formattare quello che scrivo... quindi, chi può salvarmi adesso?

Entra in Markdown . Facile da scrivere, richiede pochissimo tempo per abituarsi alla sintassi e il risultato finale è più che accettabile!

Ora immagina questa situazione: stai sfogliando una grande base di codice nel tuo editor di testo preferito, e ti imbatti in una funzione o in un utilizzo del metodo e vuoi rivisitare la sua implementazione. Quello che faccio normalmente in questo caso è avviare una ricerca a livello di progetto su VS Code e ottengo risultati immediati. Allora perché non riuniamo il meglio di entrambi i mondi?

Markdown e VS Code insieme forniscono soluzioni per i miei due maggiori problemi con qualsiasi sistema per prendere appunti: scrivere facilmente note leggibili con il minimo sforzo di formattazione e la possibilità di interrogare le informazioni ogni volta che voglio .

Quindi, come lo costruisci? È facile come creare un repository vuoto in GitHub, quindi avviare Visual Studio Code per il Web .

Una volta che sei lì, fai clic su "Apri cartella" e VS Code dirà che l'apertura di cartelle locali non è supportata e invece ti consentirà di aprire una cartella remota. Accedendo con il tuo account GitHub, sarai in grado di aprire qualsiasi repository desideri.

Mi piace strutturare i miei appunti nel modo seguente:

- <Project Name>
  - Useful Commands
  - Research
  - Tasks

All'interno di ogni cartella di progetto, Useful Commands ospita un singolo file markdown con comandi utili per attività come l'avvio di contenitori Docker, l'esecuzione di test e così via.

La ricerca contiene note di ricerca per diversi argomenti, l'obiettivo principale qui è cercare di spiegare i concetti a me stesso come se lo stessi spiegando a qualcun altro.

Compiti è quello che credo abbia avuto il maggiore impatto sulla mia produttività. Qui inserisco un file Markdown per ogni ticket Jira che mi viene assegnato e provo a seguire questo modello:

# JIRA_ID - Ticket name
Short description of the task. 
If the task doesn't have an acceptance criteria it is a good exercise 
to read the description a few times and write it down yourself.

In here I leave a space for pasting useful material, like code snippets,
links, YouTube videos, anything that might help me answer whatever
questions arise.

## Steps To Succeed
Step by step definition, with clear action items to achieve a solution.
Include possible alternate paths, and every thought that helps you implement
your idea.

Per questo è tutto, se sei arrivato in fondo a questo post grazie mille e buona giornata! :)