В разных гайдах для авторов контента регулярно пишут, что списки хороши и облегчают восприятие. Это правда так, но на самом деле далеко не всегда.
Я в редактуре часто сталкиваюсь с ситуациями, которые выглядят примерно вот так:
«Далее необходимо разделить приложение на две части:
- клиентский код,
- серверный код.»
Сущности всего две, они короткие, но их вынести в список. В итоге мы получили лишние знаки препинания и строки — это не облегчает, а наоборот, усложняет восприятие.
На мой взгляд, если в списке две–три сущности, и они однотипные и простые — их нужно просто оставить в предложении, вот так:
«Далее необходимо разделить приложение на две части: клиентский и серверный код».Так гораздо легче и чище.
А списки нужны, когда сущностей либо очень много, либо они длинные и сложные, и каждую полезно будет воспринять по отдельности. Например, как в этом примере:
Схема может показаться слишком сложной, но на то есть своя причина. В этом поде у нас три контейнера:
1. В первом работает Vector. Его основная цель — сбор логов.
2. Второй контейнер — Reloader. У пользователей нашей платформы есть возможность описывать собственные пайплайны сборки логов. Специальный оператор берёт заданные пользователями данные и составляет configmap для Vector. Задача Reloader — проверить, что config правильный, и, если так, перезагрузить Vector.
3. Третий контейнер — Kube RBAC proxy. Он важен, поскольку Vector выводит различные метрики о собираемых логах. Эта информация может быть конфиденциальной, поэтому важно защитить её надлежащей авторизацией.