Studienotities in Markdown maken

Kies een kophiërarchie

Gebruik één hoofdtitel en logische sectieniveaus. Een kop moet een onderwerp of claim identificeren, en niet alleen maar een grotere tekst creëren. Consistente niveaus maken een inhoudsopgave nuttig.

Begin met een hoofdtitel die het onderwerp en de sessie identificeert, gebruik vervolgens kopjes op het tweede niveau voor de belangrijkste ideeën en kopjes op het derde niveau voor echte onderverdelingen. Een opmerking over experimenteel ontwerp kan bijvoorbeeld secties bevatten over de vraag, de methode, het bewijsmateriaal en de beperkingen. Vermijd het overslaan van kopniveaus alleen om de gewenste lettergrootte te verkrijgen. Als een kop een hele alinea bevat, kort deze dan in tot een zin die de onderstaande inhoud voorspelt. Lees de kopjes zonder de hoofdtekst en vraag of ze een bruikbare kaart van het onderwerp bieden. Een coherente hiërarchie helpt zowel handmatige navigatie als gegenereerde inhoudslijsten, terwijl willekeurige kopniveaus ervoor kunnen zorgen dat een korte notitie moeilijker te scannen is dan de ongeformatteerde tekst waarmee deze begon.

Houd lijsten betekenisvol

Gebruik opsommingstekens voor evenwijdige punten en genummerde stappen voor een reeks. Vervang een causale verklaring niet door losse fragmenten alleen maar omdat opsommingen van opsommingen sneller te typen zijn.

Kies de lijststructuur op basis van de betekenis. Gebruik een geordende lijst als een procedure op volgorde moet plaatsvinden en opsommingstekens als items parallelle alternatieven of kenmerken zijn. Houd een causale verklaring in zinnen wanneer de relatie als fragmenten verloren zou gaan. Als een opsommingsteken een voorwaarde introduceert, voeg dan de voorwaarde toe aan de claim waarvoor deze in aanmerking komt, in plaats van deze in een verre sublijst te plaatsen. Beperk het nesten tot relaties die u duidelijk kunt uitleggen, zoals een voorbeeld onder het principe dat het illustreert. Controleer na het opschonen of de inspringing deze relaties nog steeds weergeeft in uw bestemmingseditor. Markdown-implementaties verschillen, dus een visueel acceptabel bronbestand kan onverwacht een genest item weergeven als de spatiëring of lijstconventies niet overeenkomen met de viewer die u wilt gebruiken.

Bescherm code en formules

Gebruik omheinde blokken voor code of notatie waarvan de afstand van belang is. De reiniger bewaart de inhoud binnen hekken in plaats van daar gewone kop- en opsommingsnormalisatie toe te passen.

Verpak code waarvan de afstand van belang is in een omheind blok en voeg een taallabel toe als uw editor dit ondersteunt. Houd proza ​​buiten het blok, zodat het kan worden genormaliseerd zonder het voorbeeld te beïnvloeden. Gebruik voor vergelijkingen een notatie die uw bestemmingsrenderer daadwerkelijk begrijpt; gewone Markdown garandeert geen wiskundig zetwerk. Een vergelijking in platte tekst met een bijbehorende uitleg kan draaglijker zijn dan niet-ondersteunde markeringen. Controleer of de openings- en sluithekken aan elkaar zijn gekoppeld, omdat een niet-gesloten hek ervoor kan zorgen dat de rest van het document zich als code gedraagt. De beslissing van de schoonmaker om afgeschermde inhoud te behouden beschermt opzettelijke opmaak, maar kan niet vaststellen of de code werkt en of de wiskunde correct is. Controleer deze claims met behulp van het juiste cursusmateriaal of de juiste uitvoeringsomgeving.

Laat de stofzuiger draaien

Plak Markdown en genereer genormaliseerde koppen en opsommingstekens. Lees de uitvoer voordat u uw bron vervangt. Dit hulpprogramma formatteert de tekst; het valideert niet elk Markdown-dialect of correcte academische inhoud.

Bewaar de originele tekst voordat u deze in de reiniger plakt, vooral als deze een lange omtrek of ongebruikelijke notatie bevat. Begin met één representatief gedeelte met koppen, opsommingstekens en een omheind voorbeeld. Vergelijk de uitvoer regel voor regel rond deze structuren voordat u het hele document verwerkt. Een normalisatiepas zou de conventies consistent moeten maken, maar het komt mogelijk niet overeen met elke extensie die uw editor ondersteunt, zoals speciale highlights of ingebedde componenten. Bewaar elke niet-ondersteunde structuur in een aparte beoordelingslijst en repareer deze doelbewust in de uiteindelijke bron. Vervang uw enige kopie niet alleen maar omdat de uitvoer er netter uitziet in de tool. Correcte academische betekenis en volledige broninhoud zijn belangrijker dan het bereiken van uniforme interpunctie in het hele bestand.

Inspecteer de inhoudslijst

De tool maakt ankers van koppen en voegt achtervoegsels toe voor herhalingen. Bekijk een voorbeeld van links in uw doeleditor, omdat verschillende renderers verschillende ankerconventies kunnen gebruiken.

Test na het genereren van de inhoudsopgave de koppelingen naar de eerste kop, een kop met leestekens en eventuele herhaalde kopteksten. Twee secties die beide “Voorbeelden” worden genoemd, hebben verschillende bestemmingen nodig; een achtervoegsel kan ze in de ene renderer onderscheiden, terwijl een andere een andere conventie gebruikt. Als een link mislukt, inspecteer dan de daadwerkelijke koers-ID die door uw bestemming wordt geproduceerd, in plaats van herhaaldelijk het zichtbare label te wijzigen. Overweeg om herhaalde kopjes beschrijvender te maken, zoals 'Voorbeelden van verwarring' en 'Voorbeelden van steekproeffouten', wat ook de navigatie voor lezers verbetert. Genereer de inhoudslijst opnieuw na het hernoemen of herschikken van secties, en test vervolgens opnieuw. Een inhoudsopgave is een onderhouden navigatiehulpmiddel, geen onafhankelijke kopie van de structuur die na de eerste export veilig kan worden vergeten.

Interpreteer de beoordelingsschatting

Het aantal woorden gedeeld door de nominale beoordelingssnelheid geeft een ruwe duur weer. Uitgebreide vergelijkingen, diagrammen en onbekende concepten kunnen veel langer duren. Gebruik daadwerkelijke studiesessies om de verwachtingen te kalibreren.

Behandel de gerapporteerde beoordelingsduur als een initiële planningsschatting. Duizend woorden vertrouwd samenvattend proza ​​en duizend woorden met afleidingen vragen niet dezelfde aandacht. Plan één echte beoordelingssessie met een duidelijke taak, zoals het beantwoorden van de sectievragen zonder te kijken en de resultaten te controleren. Vergelijk die duur met de schatting en noteer waarom ze verschillen. Indien cijfers of externe referenties essentieel zijn, vermeld dan ook de tijd die nodig is om deze te inspecteren. Het aantal woorden kan helpen bij het identificeren van onverwacht lange secties, maar het verminderen van het aantal is niet automatisch een verbetering. Bewaar de uitleg die nodig is om de redenering te reconstrueren en verwijder overtollige herhalingen alleen als de resterende noot nog steeds het werk ondersteunt dat u ermee verwacht te doen.

Bewaar referenties

Plaats links of bibliografische gegevens in de buurt van beweringen die afhankelijk zijn van een bron. Een mooi georganiseerde notitie zonder herkomst is moeilijk te verifiëren als twee lezingen het niet eens zijn.

Plaats een bronverwijzing bij elke claim die mogelijk moet worden gecontroleerd, in plaats van een onverklaarde stapel links onderaan te verzamelen. Voeg een pagina- of sectielocator toe als een bron lang is. Markeer directe citaten duidelijk en bewaar hun bewoordingen; schrijf uw interpretatie afzonderlijk, zodat de twee na bewerking niet meer van elkaar te onderscheiden zijn. Wanneer twee lezingen het niet eens zijn, noteer dan de verschillende contexten of definities in plaats van ze stilzwijgend samen te voegen tot één verklaring. Test links voordat u de notitie deelt en bewaar voldoende bibliografische informatie om een ​​bron te identificeren als een link later verandert. Een schoon Markdown-bestand is eenvoudig te kopiëren, waardoor traceerbare attributie en zorgvuldige scheiding van bronclaims en persoonlijke conclusies vooral nuttig zijn bij herhaalde herzieningen.

Bewust exporteren

Sla het Markdown-bestand op voordat u de browser sluit. Bewaar een back-up voordat u een grote schoonmaakbeurt uitvoert. Als u deelt met lezers die Markdown niet gebruiken, zorg dan ook voor een geschikte weergegeven of platte tekstversie.

Sla de voltooide bron op met een beschrijvende bestandsnaam en open deze opnieuw vanaf schijf om te verifiëren dat deze daadwerkelijk is gedownload. Bewaar een gedateerde back-up voordat u grote wijzigingen aanbrengt in de kopstructuur of terminologie. Als u een gerenderde versie deelt, inspecteer deze dan in de beoogde viewer en bevestig dat tabellen, code en links bruikbaar blijven. Geef de bewerkbare bron op wanneer medewerkers deze moeten herzien, en een leesbaar alternatief wanneer ze Markdown niet gebruiken. Ga er niet van uit dat een gepolijste visuele export automatisch toegankelijk is; betekenisvolle kopjes en tekstalternatieven voor afbeeldingen vereisen nog steeds aandacht. Beëindig de workflow met een kleine studieactie, zoals het beantwoorden van de vragen onder één sectie, zodat het opgeschoonde document een werkbron wordt in plaats van een ander niet-beoordeeld bestand.

Kopieerbaar planningssjabloon

Onderwerp: Studienotities maken in Markdown
Bron en datum:
Wat ik moet onthouden of doen:
Eerste poging zonder aantekeningen:
Fout of onzekerheid:
Correctie en ondersteunende bron:
Volgende beoordeling of actie:

Invoervoorbeeld voor het opschonen van Markdown-notities:
#Celbiologie
* Membranen
##Vervoer
- Diffusie volgt een gradiënt.

Veelgestelde vragen

Verifieert het opschonen van Markdown de feiten in mijn aantekeningen?

Nee. Het normaliseert de documentstructuur en biedt navigatiehulpmiddelen. Controleer zelf de uitleg, referenties en vergelijkingen met de bron voordat u op de opgeschoonde uitvoer vertrouwt.

Hoe kan ik voorkomen dat letterlijke code een kop wordt?

Plaats code in omheinde blokken en bekijk een voorbeeld van het resultaat na het opruimen. De reiniger moet de code-inhoud behouden; bewaar een originele kopie wanneer de opmaak betekenis heeft.