Prendere appunti in Markdown

Scegli una gerarchia di intestazioni

Utilizzare un titolo principale e livelli di sezione logica. Un titolo dovrebbe identificare un argomento o un'affermazione, non limitarsi a creare un testo più ampio. Livelli coerenti rendono utile un sommario.

Inizia con un titolo principale che identifichi l'argomento e la sessione, quindi utilizza titoli di secondo livello per le idee principali e titoli di terzo livello per le suddivisioni vere e proprie. Ad esempio, una nota sul disegno sperimentale potrebbe contenere sezioni relative alla domanda, al metodo, alle prove e alle limitazioni. Evitare di saltare i livelli di intestazione solo per ottenere la dimensione del carattere preferita. Se un titolo contiene un intero paragrafo, abbrevialo in una frase che preveda il contenuto sottostante. Leggi i titoli senza il corpo e chiedi se forniscono una mappa utile dell'argomento. Una gerarchia coerente aiuta sia la navigazione manuale che gli elenchi di contenuti generati, mentre livelli di intestazione arbitrari possono rendere più difficile la scansione di una breve nota rispetto al testo non formattato da cui ha avuto inizio.

Mantieni gli elenchi significativi

Utilizza i punti elenco per i punti paralleli e i passaggi numerati per una sequenza. Non sostituire una spiegazione causale con frammenti sconnessi semplicemente perché gli elenchi puntati sono più veloci da digitare.

Scegli la struttura dell'elenco in base al significato. Utilizzare un elenco ordinato quando una procedura deve svolgersi in sequenza e punti elenco quando gli elementi sono alternative o funzionalità parallele. Mantieni una spiegazione causale nelle frasi in cui la relazione andrebbe persa in frammenti. Se un punto introduce una condizione, includere la condizione con l'affermazione che qualifica invece di inserirla in una sottolista distante. Limita l'annidamento alle relazioni che puoi spiegare chiaramente, come un esempio sotto il principio che illustra. Dopo la pulizia, controlla se il rientro esprime ancora tali relazioni nell'editor di destinazione. Le implementazioni di Markdown differiscono, quindi un file sorgente visivamente accettabile può eseguire il rendering di un elemento nidificato in modo imprevisto se le convenzioni di spaziatura o elenco non corrispondono al visualizzatore che intendi utilizzare.

Proteggi codice e formule

Utilizza blocchi recintati per codice o notazione la cui spaziatura è importante. Il pulitore preserva il contenuto all'interno dei recinti anziché applicare lì la normale normalizzazione di intestazioni e punti.

Racchiudi il codice la cui spaziatura è importante in un blocco delimitato e includi un'etichetta della lingua quando il tuo editor la supporta. Mantieni la prosa fuori dal blocco in modo che possa essere normalizzata senza influenzare l'esempio. Per le equazioni, utilizzare la notazione che il renderer di destinazione effettivamente comprende; il Markdown ordinario non garantisce la composizione matematica. Un'equazione in testo semplice con una spiegazione di accompagnamento può essere più portabile del markup non supportato. Controlla che le recinzioni di apertura e chiusura siano accoppiate, perché una recinzione non chiusa può far sì che il resto del documento si comporti come codice. La decisione del pulitore di preservare il contenuto protetto protegge la formattazione intenzionale, ma non può stabilire se il codice viene eseguito o se i calcoli sono corretti. Verificare tali affermazioni utilizzando il materiale del corso o l'ambiente di esecuzione appropriato.

Esegui l'operazione di pulizia

Incolla Markdown e genera intestazioni e punti elenco normalizzati. Leggi l'output prima di sostituire la fonte. Questa utilità riformatta il testo; non convalida ogni dialetto Markdown o il contenuto accademico corretto.

Salva il testo originale prima di incollarlo nel pulitore, soprattutto quando contiene una struttura lunga o una notazione insolita. Inizia con una sezione rappresentativa che includa titoli, elenchi puntati e un esempio recintato. Confrontare l'output riga per riga attorno a tali strutture prima di elaborare l'intero documento. Un passaggio di normalizzazione dovrebbe rendere coerenti le convenzioni, ma potrebbe non corrispondere a tutte le estensioni supportate dal tuo editor, come callout speciali o componenti incorporati. Mantieni qualsiasi struttura non supportata in un elenco di revisione separato e riparala deliberatamente nella fonte finale. Non sostituire la tua unica copia semplicemente perché l'output appare più ordinato nello strumento. Il significato accademico corretto e il contenuto originale completo contano più che ottenere una punteggiatura uniforme in tutto il file.

Esaminare l'elenco dei contenuti

Lo strumento crea ancore dai titoli e aggiunge suffissi per le ripetizioni. Visualizza l'anteprima dei collegamenti nell'editor di destinazione, poiché diversi renderer possono utilizzare convenzioni di ancoraggio diverse.

Dopo aver generato l'elenco dei contenuti, testare i collegamenti alla prima intestazione, un'intestazione contenente segni di punteggiatura e qualsiasi intestazione ripetuta. Due sezioni chiamate entrambe “Esempi” necessitano di destinazioni distinte; un suffisso può distinguerli in un renderer mentre un altro utilizza una convenzione diversa. Se un collegamento fallisce, controlla l'effettivo identificatore dell'intestazione prodotto dalla tua destinazione invece di modificare ripetutamente l'etichetta visibile. Prendi in considerazione l'idea di rendere i titoli ripetuti più descrittivi, come "Esempi di confusione" ed "Esempi di errori di campionamento", che migliorano anche la navigazione per i lettori. Rigenera l'elenco dei contenuti dopo aver rinominato o riordinato le sezioni, quindi riprova. Un elenco dei contenuti è un aiuto alla navigazione mantenuto, non una copia indipendente della struttura che può essere tranquillamente dimenticata dopo la prima esportazione.

Interpretare il preventivo di revisione

Il conteggio delle parole diviso per una velocità di revisione nominale fornisce una durata approssimativa. Equazioni dense, diagrammi e concetti non familiari possono richiedere molto più tempo. Utilizzare sessioni di studio effettive per calibrare le aspettative.

Trattare la durata della revisione riportata come una stima di pianificazione iniziale. Mille parole di prosa riassuntiva familiare e mille parole contenenti derivazioni non richiedono la stessa attenzione. Organizza una vera sessione di revisione con un compito chiaro, come rispondere alle domande della sezione senza guardare e controllare i risultati. Confronta tale durata con la stima e nota perché differiscono. Se le figure o i riferimenti esterni sono essenziali, includere il tempo necessario per esaminarli. Il conteggio delle parole può aiutare a identificare sezioni inaspettatamente lunghe, ma ridurre il conteggio non rappresenta automaticamente un miglioramento. Conserva le spiegazioni necessarie per ricostruire il ragionamento e rimuovi le ripetizioni ridondanti solo quando la nota rimanente supporta ancora il lavoro che ti aspetti di fare con essa.

Conserva i riferimenti

Mantieni collegamenti o dettagli bibliografici vicino ad affermazioni che dipendono da una fonte. Una nota ben organizzata senza provenienza è difficile da verificare quando due letture non sono d'accordo.

Posiziona un riferimento alla fonte accanto a ciascuna affermazione che potrebbe richiedere un controllo, anziché raccogliere una pila di collegamenti inspiegabili in fondo. Includi un localizzatore di pagina o sezione quando la fonte è lunga. Contrassegnare chiaramente le citazioni dirette e preservarne la formulazione; scrivi la tua interpretazione separatamente in modo che le due non diventino indistinguibili dopo la modifica. Quando due letture non sono d'accordo, registra i diversi contesti o definizioni invece di unirli silenziosamente in un'unica affermazione. Testare i collegamenti prima di condividere la nota e conservare informazioni bibliografiche sufficienti per identificare una fonte se un collegamento successivamente cambia. Un file Markdown pulito è facile da copiare, il che rende particolarmente utile l'attribuzione tracciabile e l'attenta separazione delle affermazioni della fonte dalle conclusioni personali nel caso di revisioni ripetute.

Esportare deliberatamente

Salva il file Markdown prima di chiudere il browser. Conserva un backup prima di una pulizia di grandi dimensioni. Se condividi con lettori che non utilizzano Markdown, fornisci anche una versione renderizzata o in testo semplice adatta.

Salva la fonte finita con un nome file descrittivo e riaprila dal disco per verificare che sia stata effettivamente scaricata. Conserva un backup datato prima di modifiche generali alla struttura delle intestazioni o alla terminologia. Se condividi una versione renderizzata, controllala nel visualizzatore previsto e verifica che tabelle, codice e collegamenti rimangano utilizzabili. Fornisci la fonte modificabile quando i collaboratori devono rivederla e un'alternativa leggibile quando non utilizzano Markdown. Evitare di dare per scontato che un'esportazione visiva raffinata sia automaticamente accessibile; le intestazioni significative e le alternative testuali per le immagini richiedono ancora attenzione. Termina il flusso di lavoro con una piccola azione di studio, come rispondere alle domande in una sezione, in modo che il documento ripulito diventi una risorsa di lavoro invece di un altro file non revisionato.

Modello di pianificazione copiabile

Argomento: prendere appunti di studio in Markdown
Fonte e data:
Cosa devo ricordare o fare:
Primo tentativo senza note:
Errore o incertezza:
Correzione e fonte di supporto:
Revisione o azione successiva:

Esempio di input per il pulitore delle note Markdown:
#Biologia cellulare
* Membrane
##Trasporti
- La diffusione segue un gradiente.

Domande frequenti

La pulizia Markdown verifica i fatti nelle mie note?

No. Normalizza la struttura del documento e fornisce aiuti alla navigazione. Controlla tu stesso le spiegazioni, i riferimenti e le equazioni rispetto alla fonte prima di fare affidamento sull'output ripulito.

Come posso evitare che il codice letterale diventi un'intestazione?

Inserisci il codice in blocchi recintati e visualizza in anteprima il risultato dopo la pulizia. Il pulitore dovrebbe preservare il contenuto del codice; conservare una copia originale quando la formattazione ha significato.