Как стать автором
Обновить

Строкам грустно в одиночестве. Мои простые правила оформления списков

Время на прочтение5 мин
Количество просмотров9.1K
Всего голосов 56: ↑53 и ↓3+63
Комментарии30

Комментарии 30

ЗакрепленныеЗакреплённые комментарии

Мама меня с детства приучала к "схватываемой глазами" организации информации, но я вечно забывала об этом и "катала" простыни в тетрадках. Влюбилась я в списки, когда однажды увидела тетрадки новенькой девочки в 8 классе - у неё всё было отделено точками, стрелками, тире в виде списков. Открыла - глазом схватила, пошла - ответила. Тетради так вести было лень и наплевать (были уже другие цели в обучении), а вот на подготовке к олимпиадам раскладывала всю информацию на листах А4 и по дороге на олимпиады просто пролистывала их и освежала в памяти. Ну а в вузе по моим конспектам 3-4 курса учились ещё :-)

Активно использую и люблю списки, на обучении авторов всегда рекомендую их как паттерн оформления статей, однако действительно в последнее время приходится добавлять ремарку про нейросети. А если не добавить - как правило, спрашивают об этом :-)

Вещи, которые я ненавижу:

  • I. Римские цифры

  • II. Римские цифры

  • III. Римские цифры

  • IIII. Римские цифры

:)

Нумерованные списки я использую только в том случае, если важен порядок следования строк.

Ещё это естественный способ обозначить общее количество (совпадающее с номером последнего пункта).

...а также нормально ссылаться на конкретный пункт, - о чём далее автор упомянул, но почему-то это не повлияло на изначальную рекомендацию. В юридических документах часто надо ссылаться на нормативные акты, судебные решения, документы твоего оппонента, и высчитывать вручную, какой там это по очереди абзац, - бесит.

В некоторых странах в юридической практике для этого принята сквозная нумерация строк или абзацев во всём документе - но, увы, не у нас.

И инструкции. Насколько проще, особенно, когда по телефону, руководишь действиями на "той стороне". "Вы сделали с первого по пятый пункт? Что на экране? Тогда идем на следующую страницу сразу к пункту 3". И никакого недопонимания. Ну, практически.

Мама меня с детства приучала к "схватываемой глазами" организации информации, но я вечно забывала об этом и "катала" простыни в тетрадках. Влюбилась я в списки, когда однажды увидела тетрадки новенькой девочки в 8 классе - у неё всё было отделено точками, стрелками, тире в виде списков. Открыла - глазом схватила, пошла - ответила. Тетради так вести было лень и наплевать (были уже другие цели в обучении), а вот на подготовке к олимпиадам раскладывала всю информацию на листах А4 и по дороге на олимпиады просто пролистывала их и освежала в памяти. Ну а в вузе по моим конспектам 3-4 курса учились ещё :-)

Активно использую и люблю списки, на обучении авторов всегда рекомендую их как паттерн оформления статей, однако действительно в последнее время приходится добавлять ремарку про нейросети. А если не добавить - как правило, спрашивают об этом :-)

Вы мудрец. Вы всё правильно разложили. Спасибо вам.

Полезно.

Насчёт вложенности: для педантов. Использую. Правда, больше трёх не делал.

Насчёт римских цифр: использую. Да, не особо (для кого-то) удобно, наглядно. Нумерую ими главы. Внутри глав — арабские. Для разнообразия (согласен, спорно).

И да, для ссылок нумерация весьма удобна.

Вещи, которые я ненавижу:

  • I. Римские цифры

  • II. Римские цифры

  • III. Римские цифры

  • IIII. Римские цифры

:)

I. Спасибо

II. Спасибо

II. Спасибо

IV. Спасибо (исправил)

:)

Я вот не очень люблю не ненумерованные списки, которые выделены буллитами (•), которые нельзя скопировать, вот, например, что будет если скопировать ваш текст:

Вещи, которые я ненавижу:

I. Римские цифры

II. Римские цифры

III. Римские цифры

IIII. Римские цифры

:)

То есть написанный автором текст (любой) может потерять смысл, только из-за не скопированный элементов

Хотя такая проблема есть и у нумерованных списков, но реже

Уровень вложенности — не больше 5.

Если честно, я уже всерьёз подумываю уменьшить свой лимит вложенности до 4.

Имхо, уровней вложенности не более трех, то есть:

1.

1.1.

1.1.1

Если больше — сложно для восприятия и часто обозначает плохую структурированность документа, значит надо ее пересмотреть

Когда это какая-нибудь проектная документация по ГОСТу на 500 листов, тремя уровнями обойтись крайне проблематично :(

Смотря по какому ГОСТу. Есть такие ГОСТы, которые подразумевают не более 2 уровней. Просто в дополнение к изложенным автором приёмам нормализации текста изложу, на сколько я помню, гостовский подход (один из). Для иллюстрации того, почему следует использовать буквы в перечислениях, позвольте мне начать несколько издалека )))

  1. Разделы нумеруются, имеют заголовки, выделенные шрифтом, начинаются с новой страницы

    1.1 Подразделы нумеруются, имеют заголовки, выделенные [другим, нежели разделы] шрифтом, с новой страницы не начинаются

    1.1.1 Пункты нумеруются, заголовков не имеют, шрифтом не выделяются.

    1.1.1.1 Подпункты нумеруются, заголовков не имеют, шрифтом не выделяются.

    1.1.1.2 Пункты и подпункты состоят, преимущественно, из одного абзаца (в исключительных случаях - до пяти абзацев). На них тоже удобно ссылаться и они, по-сути, сами по себе являются своеобразным перечислением.

    1.1.2 Ненумерованные списки:

    - имеют один уровень вложенности;

    - начинаются с тире;

    - разделяются точкой с запятой (следовательно, никаких нескольких предложений - для подобного есть пункты и подпункты, они тоже нумеруются);

    - заканчиваются точкой.

    1.1.2 Нумерованный список:

    а) может иметь два уровня вложенности;

    б) первый уровень нумеруется буквами со скобочкой, чтобы нумерация не путалась с нумерацией пунктов и подпунктов (плюс некоторые буквы, вроде "о", рекомендуется не использовать в нумерации);

    в) второй уровень:

    ----1) нумеруется цифрами со скобочкой (смысл тот же);

    ----2) дополнительно отличается от первого абзацным отступом (вместо которого тут пришлось использовать ----).

    г) нумерованный список используется, когда необходимо ссылаться в тексте на какое-то из перечислений.

  • «-» — это дефис

  • «—» — это тире

  • :)

Стараюсь поддерживать уровень вложенности 1, в крайнем случае 2.

Если уровней больше - я уже сам текст логически разделю, типа "список А" и "список Б". Или просто разверну его в плоский вид.

Например, если это чек-лист вещей в поездку, я не буду разводить дерево типа рюкзак->электроника->ноутбук->зарядка для телефона, а просто сделаю два или три списка по смыслу - электроника, одежда, документы-билеты-деньги.
А зарядку для ноутбука просто впишу в пункт с ноутбуком (например, "ноутбук + зарядка + мышь"), не раздувая текст по вертикали.

Не знаю зачем делать 4 или 5 уровней - ориентироваться в таком будет сложно.

Меня всегда удивляют списки, состоящие из грустной одинокой строки. Обычно они появляются в текстах и документации, когда есть несколько однотипных разделов.

Вот, кстати, именно обилие маркированных списков из одного пункта (если это не документация, особенно по API или чему-то подобному) - один из признаков сгенерированного текста. А в сочетании с другими нейросетизмами - практически гарантированный признак.

Хотелось бы высказаться в защиту перечислений из одного пункта. Иногда они позволяют не ломать визуальную структуру текста и существенно упрощают восприятие. Пример ниже.

Оценку "отл" получили:

  • Иванов Иван Иванович.

Оценку "хор" получили:

  • Петров Пётр Петрович;

  • Гаврилов Гаврила Гаврилович;

  • ... .

Оценку "уд" получили:

  • ... ;

  • ... ;

  • ... .

Сразу видно, что молодец только Иван. Это гораздо проще заметить в подобной форме изложения, нежели если успехи Ивана были бы просто раскрыты в абзаце обычного текста.

Главное, ссылаться на эти пункты не так, как принято в юридической сфере - именно "на пункт 1.3.4", а не "пункт 4 главы 3 раздела 1".

Вторым способом автоматически обновляемую перекрёстную ссылку проставить, мягко говоря, затруднительно. А ссылки, проставленные вручную текстом, - путь к боли и страданиям при последующих корректировках документа.

Абзац 3 п. 6.2 ст. 7.3 гл. 9.2

Существует предложение (не моё) принять в виде стандарта ссылок что-то вроде такого:

 9.2 · 7.3 · 6.2 · 3 ФЗ-123 «О том-то»

Т.е. в обратном порядке (от большего) и через разделитель (среднюю точку), а в конце записи краткое название документа.

Меня всегда удивляют списки, состоящие из грустной одинокой строки. Обычно они появляются в текстах и документации, когда есть несколько однотипных разделов.

Не понимаю, чем автору не угодили списки из одного пункта в следующем случае:

Например, в документе описываются какие-то API-методы.

Цель документации - донести информацию доступно и быстро, и единообразная подача информации очень с этим помогает. Если в документе параметры метода всегда перечисляются списком - то так следует делать и с методами, у которых один параметр.

Единообразие в документации гораздо важнее, чем чьё-то чувство прекрасного.

У меня бы и чувство прекрасного пострадало, если бы одинаковые по значению в тексте блоки выглядели бы по-разному.

И чтобы такого не допустить, для тех случаев, когда возможна единственная строка, я бы выбрал не список, а, скажем, таблицу (можно без видимых границ, просто три колонки - название параметра, тип данных, описание). По современной типографике тонны рекомендаций написаны, которые позволяют сделать и читаемо, и красиво.

Мне иногда приходится на работе выполнять, скажем так, исследования уже имеющихся артефактов, типа "выбрать из имеющейся документации параметры процедур/функций или предусловия к кейсам".

Если в документации искомые фрагменты оформлены одинаково, задачу можно решить простым (ну или сложным) регулярным выражением. Если же однообразия нет и где-то список, где-то перечисление через запятую, где-то по пяти абзацам разбросано - приходится сидеть и читать.

Более того, я бы даже предложил подумать над перечислениями из 0 пунктов. Иногда они позволяют весьма удобным (в т.ч. для чтения) образом снять двусмысленность. Как иллюстрация: в моём примере перечисления из одного пункта, изложенном выше, сохраняется некая недосказанность, ибо не понятно - получил ли кто-то таки "неуд", или их просто отчислили и потому в листке с результатами не перечисляли?

Если ситуация такова, что требуется перечисление из 0 пунктов, то имеет смысл перенести перечисление в формат таблицы, и там в соответствующей ячейке поставить прочерк.

Да, но иногда пункты перечисления бывают весьма длинные (даже из одного предложения) и смотрятся в ячейке таблицы довольно посредственно. Плюс такая таблица размазывает информацию, так как в левом столбце остается куча пустого места - и это затрудняет восприятие.

Вот не помню где и когда, но где-то в рекомендациях по деловой переписке встречал рекомендацию списков избегать. Да и в жизни встречал множество тщательно подготовленных текстов, где списки прямо напрашивались, но вместо них использовались сложноподчинённые предложения. И да и пару раз слышал от живых людей совет переписать список "покороче". Т.е. есть такая школа письма осознанно антагонистичная спискам. Я этого не понимаю, а автора поддержу - списки рулят и педалят в документации, переписке, заметках и примерно везде, кроме художественной литературы.

Вот бы всех этих антисписочных людей записать в список и в биореактор и допросить на предмет а что им, собственно, не так.

а что им, собственно, не так.

Они считают это нудным.

Я же нудный. И люблю списки. Так нагляднее (I.M.H.O.).

мне нравятся простые списки. Все остальное - только усложнять

Если бы существовал список самых лучших вещей в мире, то списки были бы там на первом месте (Шелдон Купер)

Зарегистрируйтесь на Хабре, чтобы оставить комментарий

Публикации