Markdownで学習ノートを取る

見出し階層を選択します

1 つのメイン タイトルと論理セクション レベルを使用します。見出しは、単に大きなテキストを作成するだけでなく、トピックや主張を識別する必要があります。一貫したレベルにより、目次が役に立ちます。

主題とセッションを識別するメイン タイトルから始めて、主要なアイデアには第 2 レベルの見出しを使用し、実際の細分化には第 3 レベルの見出しを使用します。 For example, a note about experimental design might contain sections for the question, method, evidence and limitations.好みのフォント サイズを得るために見出しレベルをスキップすることは避けてください。 If a heading contains an entire paragraph, shorten it to a phrase that predicts the content below. Read the headings without the body and ask whether they provide a useful map of the topic.一貫した階層は、手動ナビゲーションと生成されたコンテンツ リストの両方に役立ちますが、任意の見出しレベルにより、短いメモは、それが開始された書式設定されていないテキストよりも読みにくくなる可能性があります。

リストを意味のあるものに保つ

平行点には箇条書きを使用し、シーケンスには番号付きステップを使用します。箇条書きの方が入力が早いという理由だけで、因果関係の説明を切り離された断片に置き換えないでください。

意味に応じてリストの構造を選択します。手順を順番に実行する必要がある場合は順序付きリストを使用し、項目が並列の代替案または機能である場合は箇条書きを使用します。関係性が断片として失われてしまう場合には、因果関係を文章で説明してください。箇条書きで条件を導入する場合は、その条件を遠くのサブリストに置くのではなく、その条件を修飾するクレームに含めます。ネストは、説明する原則の下にある例など、明確に説明できる関係に限定してください。クリーニング後、宛先エディターでインデントが依然としてそれらの関係を表現しているかどうかを検査します。マークダウンの実装は異なるため、スペースやリストの規則が使用する予定のビューアと一致しない場合、視覚的に受け入れられるソース ファイルでもネストされた項目が予期せずレンダリングされる可能性があります。

コードと式を保護する

間隔が重要なコードまたは表記には、フェンスで囲まれたブロックを使用します。クリーナーは、通常の見出しや箇条書きの正規化をフェンス内に適用するのではなく、フェンス内のコンテンツを保持します。

スペースが重要なコードはフェンスで囲まれたブロックで囲み、エディターが言語ラベルをサポートしている場合は言語ラベルを含めます。例に影響を与えずに正規化できるように、散文をブロックの外側に置いてください。方程式の場合は、宛先レンダラーが実際に理解できる表記法を使用してください。通常の Markdown は数学的な組版を保証しません。説明を伴うプレーンテキストの方程式は、サポートされていないマークアップよりも移植性が高い場合があります。フェンスが閉じられていないと、ドキュメントの残りの部分がコードのように動作する可能性があるため、開閉フェンスがペアになっていることを確認してください。フェンスで囲まれたコンテンツを保持するというクリーナーの決定は、意図的な書式設定を保護しますが、コードが実行されるかどうか、または計算が正しいかどうかを確認することはできません。適切なコース教材または実行環境を使用して、これらの主張を検証してください。

クリーナーを実行します

Markdown を貼り付け、正規化された見出しと箇条書きを生成します。ソースを置き換える前に出力を読んでください。このユーティリティはテキストを再フォーマットします。すべての Markdown 方言や正しい学術コンテンツを検証するわけではありません。

特に長いアウトラインや特殊な表記が含まれている場合は、元のテキストをクリーナーに貼り付ける前に保存してください。見出し、箇条書き、枠で囲まれた例を含む代表的な 1 つのセクションから始めます。文書全体を処理する前に、これらの構造の前後の出力を 1 行ずつ比較します。正規化パスは規則に一貫性を持たせる必要がありますが、特別なコールアウトや埋め込みコンポーネントなど、エディターがサポートするすべての拡張機能に一致するとは限りません。サポートされていない構造は別のレビュー リストに保存し、最終ソースで意図的に修復します。ツール内で出力がきれいに見えるという理由だけで、唯一のコピーを置き換えないでください。正しい学術的意味と完全なソース コンテンツは、ファイル全体で均一な句読点を実現することよりも重要です。

コンテンツリストを確認する

このツールは見出しからアンカーを作成し、繰り返しのサフィックスを追加します。レンダラごとに異なるアンカー規則が使用される可能性があるため、リンク先エディタでリンクをプレビューします。

コンテンツ リストを生成した後、最初の見出し、句読点を含む見出し、および繰り返しの見出しへのリンクをテストします。どちらも「例」と呼ばれる 2 つのセクションには、個別の宛先が必要です。あるレンダラーではサフィックスによってそれらが区別され、別のレンダラーでは異なる規則が使用される場合があります。リンクが失敗した場合は、表示されるラベルを繰り返し変更するのではなく、リンク先によって生成された実際の見出し識別子を検査してください。 「交絡の例」や「サンプリングエラーの例」など、繰り返される見出しをより説明的なものにすることを検討してください。これにより、読者のナビゲーションも向上します。セクションの名前を変更または並べ替えた後、コンテンツ リストを再生成し、再度テストします。コンテンツ リストは、維持されるナビゲーション補助であり、最初のエクスポート後に忘れても問題ない構造の独立したコピーではありません。

レビューの見積もりを解釈する

単語数を公称レビュー速度で割ると、おおよその期間がわかります。緻密な方程式、図、馴染みのない概念の場合は、さらに時間がかかることがあります。実際の勉強会を利用して期待値を調整します。

報告されたレビュー期間を初期計画の見積もりとして扱います。よく知られた要約散文の 1000 語と派生を含む 1000 語は、同じ注意を必要としません。結果を見たり確認したりせずにセクションの質問に答えるなど、明確なタスクを伴う実際のレビュー セッションを 1 回行います。その期間を見積もりと比較し、なぜ異なるのかに注目してください。図や外部参照が不可欠な場合は、それらを検査するのに必要な時間を含めてください。文字数は、予想外に長いセクションを特定するのに役立ちますが、文字数を減らしても自動的に改善されるわけではありません。推論を再構築するために必要な説明を保持し、残りのメモがそれを使って行う予定の作業をサポートしている場合にのみ、冗長な繰り返しを削除します。

参照を保持する

リンクや参考文献の詳細は、出典に依存する主張の近くに置いてください。出典のない美しく整理されたメモは、2 つの読みが一致しない場合に検証するのが困難です。

説明のないリンクの山を下部に集めるのではなく、チェックが必要な各主張の近くにソース参照を配置します。ソースが長い場合は、ページまたはセクション ロケーターを含めます。直接の引用には明確にマークを付け、その文言を保持します。編集後に 2 つが区別できなくなることのないように、解釈を別々に書いてください。 2 つの解釈が一致しない場合は、それらを黙って 1 つのステートメントにマージするのではなく、異なるコンテキストまたは定義を記録します。メモを共有する前にリンクをテストし、後でリンクが変更された場合にソースを特定するのに十分な書誌情報を保持します。クリーンな Markdown ファイルは簡単にコピーできるため、帰属を追跡でき、ソースの主張と個人的な結論とを慎重に分離することが、改訂を繰り返す場合に特に役立ちます。

意図的に輸出する

ブラウザを閉じる前に Markdown ファイルを保存します。大規模なクリーンアップを行う前にバックアップを作成してください。 Markdown を使用しない読者と共有する場合は、適切なレンダリングされたバージョンまたはプレーンテキストのバージョンも提供してください。

完成したソースをわかりやすいファイル名で保存し、ディスクから再度開き、実際にダウンロードされたことを確認します。見出しの構造や用語を大幅に変更する前に、日付のバックアップを保管してください。レンダリングされたバージョンを共有する場合は、目的のビューアでそれを検査し、テーブル、コード、リンクが引き続き使用できることを確認します。共同作業者が改訂する必要がある場合は編集可能なソースを提供し、Markdown を使用しない場合は読み取り可能な代替ソースを提供します。洗練されたビジュアルエクスポートに自動的にアクセスできると想定しないでください。意味のある見出しや画像の代替テキストには依然として注意が必要です。ワークフローは、1 つのセクションの質問に答えるなどの小さな学習アクションで終了します。これにより、クリーンアップされたドキュメントが、レビューされていない別のファイルの代わりに作業リソースになります。

コピー可能な計画テンプレート

トピック: Markdown で学習ノートを作成する
出典と日付:
思い出したり、やるべきこと:
メモなしで最初の試み:
エラーまたは不確実性:
訂正と裏付けソース:
次のレビューまたはアクション:

Markdown ノート クリーナーの入力例:
#細胞生物学
* 膜
##輸送
- 拡散は勾配に従います。

よくある質問

Markdown クリーンアップはメモ内の事実を検証しますか?

いいえ。文書構造を正規化し、ナビゲーション補助を提供します。クリーンな出力に頼る前に、説明、参考文献、方程式をソースと照らし合わせて自分で確認してください。

リテラルコードが見出しにならないようにするにはどうすればよいですか?

フェンスで囲まれたブロックにコードを配置し、クリーンアップ後に結果をプレビューします。クリーナーはコードの内容を保持する必要があります。フォーマットに意味がある場合は、元のコピーを保持してください。