Tworzenie notatek w Markdown

Wybierz hierarchię nagłówków

Użyj jednego głównego tytułu i logicznych poziomów sekcji. Nagłówek powinien identyfikować temat lub twierdzenie, a nie tylko tworzyć większy tekst. Spójne poziomy sprawiają, że spis treści jest użyteczny.

Rozpocznij od głównego tytułu, który identyfikuje temat i sesję, następnie użyj nagłówków drugiego poziomu dla głównych idei i nagłówków trzeciego poziomu dla prawdziwych podziałów. Na przykład uwaga dotycząca projektu eksperymentu może zawierać sekcje dotyczące pytania, metody, dowodów i ograniczeń. Unikaj pomijania poziomów nagłówków wyłącznie w celu uzyskania preferowanego rozmiaru czcionki. Jeśli nagłówek zawiera cały akapit, skróć go do frazy, która przewiduje treść poniżej. Przeczytaj nagłówki bez treści i zapytaj, czy stanowią użyteczną mapę tematu. Spójna hierarchia ułatwia zarówno ręczną nawigację, jak i generowane listy treści, podczas gdy dowolne poziomy nagłówków mogą sprawić, że krótka notatka będzie trudniejsza do zeskanowania niż niesformatowany tekst, od którego się zaczęła.

Dbaj o to, aby listy miały sens

Użyj punktorów dla punktów równoległych i ponumerowanych kroków dla sekwencji. Nie zastępuj wyjaśnienia przyczynowego niepołączonymi fragmentami tylko dlatego, że listy punktowane szybciej się pisze.

Wybierz strukturę listy według znaczenia. Użyj uporządkowanej listy, jeśli procedura musi odbywać się po kolei, i punktorów, jeśli elementy są równoległymi alternatywami lub funkcjami. Zachowaj wyjaśnienie przyczynowe w zdaniach, gdy związek zostałby utracony w postaci fragmentów. Jeśli punktor wprowadza warunek, uwzględnij go w twierdzeniu, do którego się kwalifikuje, zamiast umieszczać go na odległej podliście. Ogranicz zagnieżdżanie do relacji, które możesz jasno wyjaśnić, na przykład pod zasadą, którą ilustruje. Po wyczyszczeniu sprawdź, czy wcięcia nadal wyrażają te relacje w edytorze docelowym. Implementacje Markdown różnią się, więc wizualnie akceptowalny plik źródłowy może nieoczekiwanie wyrenderować zagnieżdżony element, jeśli odstępy lub konwencje list nie odpowiadają przeglądarce, której zamierzasz używać.

Chroń kod i formuły

Używaj ogrodzonych bloków do kodowania lub notacji, których odstępy mają znaczenie. Narzędzie czyszczące zachowuje zawartość wewnątrz płotów, zamiast stosować tam zwykłą normalizację nagłówków i punktorów.

Zawiń kod, którego odstępy mają znaczenie, w ogrodzony blok i dołącz etykietę języka, jeśli obsługuje to Twój edytor. Trzymaj prozę poza blokiem, aby można ją było znormalizować bez wpływu na przykład. W przypadku równań użyj notacji zrozumiałej dla docelowego modułu renderującego; zwykły Markdown nie gwarantuje składu matematycznego. Równanie w postaci zwykłego tekstu z towarzyszącym wyjaśnieniem może być bardziej przenośne niż nieobsługiwane znaczniki. Sprawdź, czy bariery otwierające i zamykające są sparowane, ponieważ niezamknięta granica może sprawić, że reszta dokumentu będzie zachowywać się jak kod. Decyzja osoby sprzątającej o zachowaniu chronionej zawartości chroni celowe formatowanie, ale nie może ustalić, czy kod działa i czy obliczenia są prawidłowe. Zweryfikuj te twierdzenia, korzystając z odpowiednich materiałów szkoleniowych lub środowiska wykonawczego.

Uruchom odkurzacz

Wklej Markdown i wygeneruj znormalizowane nagłówki i punktory. Przeczytaj wynik przed wymianą źródła. To narzędzie ponownie formatuje tekst; nie sprawdza każdego dialektu Markdown ani poprawnych treści akademickich.

Zapisz oryginalny tekst przed wklejeniem go do odkurzacza, szczególnie jeśli zawiera długi kontur lub nietypowy zapis. Zacznij od jednej reprezentatywnej sekcji zawierającej nagłówki, wypunktowania i odgrodzony przykład. Porównaj wynik linia po linii wokół tych struktur przed przetworzeniem całego dokumentu. Przepustka normalizacyjna powinna zapewnić spójność konwencji, ale może nie pasować do wszystkich rozszerzeń obsługiwanych przez Twój edytor, takich jak specjalne objaśnienia lub osadzone komponenty. Zachowaj każdą nieobsługiwaną strukturę na osobnej liście recenzyjnej i napraw ją celowo w ostatecznym źródle. Nie wymieniaj swojej jedynej kopii tylko dlatego, że wydruk w narzędziu wygląda na bardziej uporządkowany. Prawidłowe znaczenie akademickie i kompletna treść źródłowa są ważniejsze niż osiągnięcie jednolitej interpunkcji w całym pliku.

Sprawdź listę zawartości

Narzędzie tworzy kotwice z nagłówków i dodaje przyrostki dla powtórzeń. Wyświetl podgląd łączy w edytorze docelowym, ponieważ różne moduły renderujące mogą używać różnych konwencji zakotwiczenia.

Po wygenerowaniu spisu treści przetestuj linki do pierwszego nagłówka, nagłówka zawierającego znaki interpunkcyjne i dowolnego powtarzającego się nagłówka. Dwie sekcje, obie zwane „Przykładami”, wymagają odrębnych miejsc docelowych; przyrostek może je rozróżnić w jednym renderowaniu, podczas gdy inny używa innej konwencji. Jeśli połączenie nie powiedzie się, zamiast wielokrotnie zmieniać widoczną etykietę, sprawdź rzeczywisty identyfikator nagłówka wygenerowany przez miejsce docelowe. Rozważ nadanie powtarzającym się nagłówkom bardziej opisowego charakteru, np. „Przykłady błędów” i „Przykłady błędu próbkowania”, co również usprawni nawigację dla czytelników. Po zmianie nazwy lub kolejności sekcji wygeneruj ponownie listę zawartości, a następnie przetestuj ponownie. Lista treści jest utrzymywaną pomocą w nawigacji, a nie niezależną kopią struktury, o której można bezpiecznie zapomnieć po pierwszym eksporcie.

Zinterpretuj szacunki przeglądu

Liczba słów podzielona przez nominalną szybkość przeglądania daje przybliżony czas trwania. Gęste równania, diagramy i nieznane koncepcje mogą zająć znacznie więcej czasu. Wykorzystaj rzeczywiste sesje studyjne, aby skalibrować oczekiwania.

Traktuj zgłoszony czas trwania przeglądu jako wstępny szacunek planowania. Tysiąc słów znanej prozy podsumowującej i tysiąc słów zawierających dedukcje nie wymagają takiej samej uwagi. Poświęć jedną prawdziwą sesję przeglądu z jasnym zadaniem, takim jak udzielenie odpowiedzi na pytania z sekcji bez patrzenia i sprawdzania wyników. Porównaj ten czas trwania z szacunkiem i zanotuj, dlaczego się różnią. Jeżeli istotne są liczby lub odniesienia zewnętrzne, należy uwzględnić czas wymagany na ich sprawdzenie. Liczba słów może pomóc w identyfikacji nieoczekiwanie długich sekcji, ale zmniejszenie liczby słów nie oznacza automatycznie poprawy. Zachowaj wyjaśnienia potrzebne do zrekonstruowania rozumowania i usuń zbędne powtórzenia tylko wtedy, gdy pozostała notatka nadal wspiera pracę, którą masz zamiar z nią wykonać.

Zachowaj referencje

Trzymaj linki i szczegóły bibliograficzne w pobliżu twierdzeń zależnych od źródła. Pięknie uporządkowaną notatkę bez pochodzenia trudno zweryfikować, gdy dwa odczytania są ze sobą sprzeczne.

Zamiast zbierać niewyjaśniony stos linków na dole, umieść odnośnik do źródła obok każdego twierdzenia, które może wymagać sprawdzenia. Jeśli źródło jest długie, dołącz lokalizator strony lub sekcji. Zaznacz wyraźnie cytaty bezpośrednie i zachowaj ich brzmienie; napisz swoją interpretację osobno, aby po edycji nie stały się nie do odróżnienia. Jeśli dwa odczytania nie są ze sobą zgodne, zapisz różne konteksty lub definicje, zamiast po cichu łączyć je w jedno stwierdzenie. Przetestuj linki przed udostępnieniem notatki i zachowaj wystarczającą ilość informacji bibliograficznych, aby zidentyfikować źródło w przypadku późniejszej zmiany łącza. Czysty plik Markdown można łatwo skopiować, co sprawia, że ​​identyfikowalna atrybucja i staranne oddzielenie twierdzeń źródłowych od osobistych wniosków jest szczególnie przydatne w przypadku wielokrotnych poprawek.

Eksportuj świadomie

Zapisz plik Markdown przed zamknięciem przeglądarki. Zachowaj kopię zapasową przed dużym porządkiem. Jeśli udostępniasz czytelnikom, którzy nie korzystają z Markdown, udostępnij również odpowiednią wersję renderowaną lub zwykły tekst.

Zapisz gotowe źródło z opisową nazwą pliku i otwórz je ponownie z dysku, aby sprawdzić, czy zostało faktycznie pobrane. Przed wprowadzeniem szerszych zmian w strukturze nagłówków lub terminologii należy wykonać kopię zapasową z datą. Jeśli udostępniasz wyrenderowaną wersję, sprawdź ją w przeznaczonej przeglądarce i potwierdź, że tabele, kod i łącza nadal nadają się do użytku. Zapewnij edytowalne źródło, gdy współpracownicy muszą je poprawić, oraz czytelną alternatywę, gdy nie korzystają z Markdown. Unikaj zakładania, że ​​dopracowany eksport wizualny jest dostępny automatycznie; znaczące nagłówki i alternatywy tekstowe dla obrazów nadal wymagają uwagi. Zakończ przepływ pracy małą czynnością studyjną, taką jak udzielenie odpowiedzi na pytania w jednej sekcji, aby wyczyszczony dokument stał się działającym zasobem, a nie kolejnym niesprawdzonym plikiem.

Szablon planowania do kopiowania

Temat: Rób notatki do nauki w Markdown
Źródło i data:
Co muszę przypomnieć lub zrobić:
Pierwsza próba bez notatek:
Błąd lub niepewność:
Źródło sprostowania i wsparcia:
Następna recenzja lub działanie:

Przykład wejścia dla narzędzia do czyszczenia notatek Markdown:
#Biologia komórki
* Membrany
##Transport
- Dyfuzja przebiega zgodnie z gradientem.

Najczęstsze pytania

Czy porządkowanie Markdown weryfikuje fakty w moich notatkach?

Nie. Normalizuje strukturę dokumentu i zapewnia pomoc w nawigacji. Zanim zaczniesz polegać na oczyszczonych wynikach, sprawdź wyjaśnienia, odniesienia i równania w źródle.

Jak zapobiec sytuacji, w której dosłowny kod stanie się nagłówkiem?

Umieść kod w odgrodzonych blokach i wyświetl podgląd wyniku po oczyszczeniu. Osoba sprzątająca powinna zachować zawartość kodu; zachowaj oryginalną kopię, jeśli formatowanie ma znaczenie.