Шпаргалка по Markdown для быстрых и чистых рабочих заметок
Зачем нужна шпаргалка по Markdown
Markdown — один из тех инструментов, которые узнают, сразу понимают их ценность, а потом забывают половину синтаксиса уже через неделю. Проблема не в том, что Markdown сложен. Проблема в том, что один пропущенный символ в середине заметки достаточно выбивает из потока, чтобы полезть в Google — а пока вкладка открывается, мысль уже потеряна.
Markdown создан в 2004 году Джоном Грубером как простой способ писать текст, который легко конвертируется в HTML. За 20 лет он стал стандартом де-факто для технической документации, заметок разработчиков, README-файлов и всё шире — для рабочих заметок в командах любого профиля.
Эта шпаргалка организована вокруг реальных рабочих задач, а не алфавитных списков синтаксиса. Держите её там, где можно открыть за две секунды.
Заголовки для структуры заметки
В Markdown три уровня заголовков для повседневной работы:
- # H1 — название документа или главная тема
- ## H2 — основной раздел
- ### H3 — подраздел внутри раздела
На практике большинству заметок нужны только H2 и H3. H1 — это обычно заголовок самой страницы или имя файла. Используйте заголовки для разделения тем, а не для украшения текста. Хорошо структурированная заметка с тремя-четырьмя H2 читается значительно быстрее, чем сплошной текст того же объёма — особенно если к ней возвращаются через неделю.
Маркированные и нумерованные списки
Два основных типа списков:
- Маркированный список: дефис и пробел перед каждым пунктом (
- пункт) - Вложенный пункт: два пробела перед дефисом для вложенного уровня
- Нумерованный список: цифра, точка, пробел (
1. первый шаг)
Используйте маркированные списки для несвязанных элементов, где порядок не важен. Нумерованные — для инструкций, шагов или ранжированных пунктов. Частая ошибка: нумеровать всё подряд там, где числа не несут смысла. Если порядок не имеет значения — маркер, а не цифра.
Чеклисты и задачи
Task lists — один из самых полезных паттернов для рабочих заметок:
- [ ]— задача не выполнена- [x]— задача выполнена
Чеклисты работают в большинстве приложений на основе Markdown: Notion, Obsidian, Logseq, Linear, GitHub. Проверьте поддержку в своём приложении — иногда нужен отдельный плагин или включение опции вручную.
Полезный приём для командной работы: добавляйте инициалы ответственного рядом с задачей, если список общий. Например: - [ ] Подготовить презентацию @АГ. Это минимальная, но рабочая система трекинга прямо в заметке совещания — без отдельного таск-менеджера.
Выделение важного
Три способа акцентировать текст:
- **жирный** — решения, ключевые метрики, важные имена
- *курсив* — определяемые термины или лёгкий акцент
~~зачёркнутый~~— варианты, которые рассмотрели и отклонили
Жирный шрифт особенно полезен в заметках с совещаний — сразу видно, где зафиксировано решение, а не просто обсуждение. Зачёркивание удобно при итерационном планировании: не удалять рассмотренные варианты, а зачёркивать — видна история мышления.
Ссылки в заметках
Синтаксис ссылки: [текст ссылки](https://url.com)
Заметка, которая ссылается на «предложение», значительно менее полезна, чем заметка с прямой ссылкой на документ. В заметках с совещаний — ссылайтесь напрямую: тикет, запись звонка, гугл-документ, источник данных.
Это занимает секунду при написании, но экономит минуты при повторном обращении. Ещё важнее: правильно оформленная ссылка в заметке исключает вопросы «а о каком документе шла речь?» при передаче заметки коллеге.
Цитаты и прямая речь
Синтаксис: > текст цитаты
Используйте цитаты для:
- Дословных фраз с совещания или звонка
- Ключевых утверждений клиента
- Важных фрагментов из исследований или документов
Цитата визуально отделяет чужие слова от ваших — это снижает риск перепутать чужую позицию со своей при возврате к заметке через несколько дней. В заметках с переговоров это особенно ценно: точная фраза клиента, а не её пересказ, часто оказывается важной деталью.
Код, команды и имена файлов
Два варианта оформления технических значений:
- Инлайн-код:
`команда`— для коротких значений: имена файлов, команды терминала, названия полей в CRM, пути - Блок кода: тройные обратные кавычки — для многострочного кода, конфигов, скриптов
Инлайн-код полезен везде, где значение не должно переформатироваться приложением: API-ключи (замаскированные), имена переменных, пути к файлам, технические идентификаторы. Даже в нетехнических заметках — имя поля в базе данных или точное название тега лучше записать в инлайн-коде, чтобы не потерять регистр и спецсимволы.
Таблицы для сравнения и матриц решений
Базовый синтаксис таблицы:
- Первая строка — заголовки, разделённые символом
| - Вторая строка — разделители (
|---|---|) - Следующие строки — данные в тех же столбцах
Таблицы работают в GitHub, Notion, Obsidian и большинстве современных инструментов для документов. Перед тем как полагаться на них, проверьте поддержку в вашем конкретном приложении — в некоторых plain-text средах таблица отображается как нечитаемые символы.
Для заметок-сравнений, матриц решений или таблиц задач с ответственными и дедлайнами — значительно чище, чем описывать то же самое прозой. Три строки таблицы заменяют абзац текста и сканируются вдвое быстрее.
Горизонтальная черта для разделения разделов
Синтаксис: --- (три дефиса на отдельной строке)
Используйте экономно — чтобы разделить чётко отличающиеся разделы в длинной заметке, или отметить конец записи совещания перед блоком дальнейших действий. Типичный паттерн: заметка совещания сверху, горизонтальная черта, затем раздел Следующие шаги с чеклистом.
Когда Markdown не помогает
Честно о ситуациях, где форматирование мешает, а не помогает:
- Быстрый мозговой штурм — форматирование тормозит фиксацию мыслей, лучше сначала выплеснуть текст, потом структурировать
- Голосовые заметки и диктовка — синтаксис не вписывается в речевой поток
- Работа с нетехническими клиентами в rich-text редакторах — они видят сырой синтаксис, а не результат
- Инструменты с отличными горячими клавишами — кнопки форматирования иногда быстрее набора символов вручную
Markdown — инструмент, а не религия. Если в конкретном контексте он замедляет работу — не используйте его.
Минимальный стартовый набор для команды
Если ваша команда только начинает работать с Markdown — стандартизируйте сначала на шести паттернах:
- Заголовки — для структуры документа
- Маркированные списки — для перечислений
- Чеклисты — для задач и дальнейших действий
- Жирный шрифт — для зафиксированных решений
- Ссылки — для референсов и источников
- Цитаты — для прямой речи и ключевых утверждений
Эти шесть паттернов покрывают 90% практических задач ведения заметок — без необходимости изучать полный синтаксис. Таблицы и блоки кода добавляйте по мере того, как команда осваивается и начинает чувствовать потребность в более сложных структурах.
Главный принцип: Markdown работает, когда его используют последовательно. Даже три-четыре синтаксических элемента, применяемых постоянно и одинаково всей командой, дают более читаемые заметки, чем десять элементов, которые каждый использует по-своему.
Совместимость синтаксиса Markdown варьируется в зависимости от приложения. Чеклисты, таблицы, сноски и другой расширенный синтаксис работают не везде — проверяйте в своём конкретном инструменте.
По теме: 5 юридических ошибок стартапа и как их избежать с помощью рабочих процессов
Источник: WorkTechJournal EN