Таблица в Markdown для сравнения вариантов
Превратите список разрозненных данных в короткую таблицу и проверьте её на узком экране.
У рабочей группы три варианта учебного занятия. В переписке длительность одного варианта оказалась рядом с названием другого, а ограничения по оборудованию обсуждались отдельно. Короткая таблица позволяет сопоставить варианты по одинаковым признакам. Читателю проще быстро найти нужную строку. Длинное объяснение или подробный план при этом остаются за пределами таблицы.
Решите, какие данные действительно сравниваются
Начните с вопроса, на который должна ответить таблица. Что можно провести за сорок минут с одним ноутбуком? Тогда понадобятся название варианта, время и оборудование. Описание упражнения пригодится после выбора и может быть вынесено на отдельную страницу. Столбец с именами авторов не помогает решить текущую задачу, если авторство уже отражено в карточках.
Проверьте, что столбцы обозначают одинаковый тип данных во всех строках. Если один человек написал время занятия, а другой включил время подготовки, такие числа нельзя сравнить напрямую. Назовите колонку «Занятие, мин» и вынесите подготовку в отдельную заметку. Вместо пустой ячейки там, где данные ещё собираются, лучше поставить «Уточняется». Пустое поле может выглядеть как забытая запись, нулевое время или отсутствие требования.
Соберите первую версию
В GitHub Flavored Markdown таблица состоит из заголовков, строки разделителей и строк данных. Вертикальные черты обозначают границы ячеек. Перед таблицей оставьте пустую строку, чтобы соседний абзац не оказался частью разметки. Пишите заголовки без лишних уточнений, если единицы уже указаны прямо в названии.
| Формат занятия | Занятие, мин | Оборудование |
| --- | ---: | --- |
| Разбор примера | 30 | Один ноутбук |
| Практика в парах | 40 | Ноутбук на пару |
| Обсуждение | 25 | Не требуется |Двоеточие справа в ячейке строки разделителей задаёт выравнивание столбца вправо, если редактор поддерживает это расширение. Это помогает глазами сопоставлять числа. Выравнивание не меняет значение ячейки. Если редактор показывает обычный текст, сначала уточните поддерживаемый диалект. Таблицы входят в GFM. Базовая спецификация CommonMark их не определяет.
Можно выровнять колонки пробелами в исходнике, если команда часто читает файлы без предпросмотра. Для отображения в браузере это обычно не требуется. Важнее, чтобы число столбцов совпадало в заголовке и строке разделителей. Следите и за телом таблицы. В GFM недостающие ячейки могут заполниться пустыми, а лишние будут отброшены. Ошибка не всегда выглядит как сломанная разметка.
Добавляйте ссылки без потери смысла
Когда выбранный вариант нужно открыть, сделайте названием строки понятную ссылку на инструкцию. В ячейке сохраняйте один короткий ответ. Если пояснение к оборудованию занимает несколько предложений, запишите в ячейке «Уточнить переходник» и дайте ссылку на список подготовки в названии занятия. Так таблица останется читабельной на телефоне и не превратится в сетку из длинных абзацев.
Проверьте ячейки с вертикальной чертой. Если этот символ является частью текста, в GFM его обычно экранируют обратной косой чертой. Не рассчитывайте, что обратные кавычки сами защитят разделитель. Откройте предпросмотр и убедитесь, что после подозрительной ячейки данные не сместились вправо и последний столбец не исчез. В сложном примере вместо длинной команды лучше привести её под таблицей и оставить в ячейке краткое название.
Проверьте, что таблица помогает сделать выбор
Попросите читателя выбрать вариант для одного ноутбука и объяснить выбор по таблице. Если два человека трактуют строку по-разному, проверьте названия столбцов. В учебном примере «ноутбук на пару» имеет смысл только вместе с числом пар. Если это меняет решение, добавьте короткое пояснение перед таблицей или пересчитайте оборудование для конкретной группы. Точность источников важнее красивой сетки.
Откройте страницу в узком окне и попробуйте прочитать последнюю ячейку каждой строки. Прокрутка внутри таблицы иногда допустима, но при трёх коротких колонках её можно избежать сокращением текста. Если данных много и строки продолжают расти, оставьте в статье только значения, нужные для решения, а полный набор сохраните в отдельном файле с указанными единицами и датой. Для сложных таблиц с несколькими уровнями заголовков стоит использовать формат, который может явно связать ячейки с заголовками.
Наконец, попробуйте скопировать исходный блок в целевой редактор. Результат должен отвечать на исходный вопрос даже при утрате выравнивания. Если площадка совсем не поддерживает таблицы, замените их короткими однотипными списками. У каждого варианта сохраните те же поля и единицы. Такая проверка заранее обнаружит зависимость от конкретного средства просмотра, а читатель получит сопоставимые данные в любом случае.
Отдельно храните условия измерения
Представьте, что два автора измерили длительность занятия. Один начал отсчёт после рассадки, второй включил объяснение и раздачу материалов. Строки выглядят одинаково точными, но отвечают на разные вопросы. Укажите правило замера рядом с таблицей и повторите измерение для одного варианта. Если единое правило принять нельзя, отметьте различие непосредственно в ячейке или вынесите значения в разные столбцы. Для оценки вроде «около получаса» сохраняйте её приблизительность. Число с лишней точностью может убедить читателя в том, чего автор не проверял. Прежде чем менять ширину или стиль таблицы, проверьте смысл каждой числовой ячейки.