#снек 56. Списки и статьи

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

Важная мысль: любую базу можно привести в порядок благодаря разделению страниц на два условных типа: списки и статьи.

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

Примеры: список компонентов, база данных бизнес-сценариев, список методов в API, список покупок.

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

Примеры: документация по компоненту, гайд о том как подключить библиотеку, любая инструкция.

Когда в список добавляют слишком много уточняющего контента, его становится сложнее сканировать и искать в нём нужное, он теряет свою лёгкость. Когда в статье начинается перечисление и большое количество ссылок как в списке, это прерывает чтение, нам сложнее дочитать.

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

@slashdesigner #первые_шаги #Obsidian #Notion