Skip to content

DISCOVERY: (QUICK-PROMO) Adapt "layered-cake" scheme #178

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
2 tasks
Tracked by #335
azinit opened this issue Jul 26, 2021 · 10 comments · Fixed by #460
Closed
2 tasks
Tracked by #335

DISCOVERY: (QUICK-PROMO) Adapt "layered-cake" scheme #178

azinit opened this issue Jul 26, 2021 · 10 comments · Fixed by #460
Assignees

Comments

@azinit
Copy link
Member

azinit commented Jul 26, 2021

Problem

This "cake scheme" was only draft of idea about "layered" project architecture.

But at the moment it's clear that we need to upgrade to more actual an complete state

Requirements

  • There is on scheme must be showed:

    • Main layers from methodology (shared, features, pages, app)
    • Main segments from methodology (ui, model, lib, api)
    • "Sliced" conception with decomposing "smth big" by "self-contained parts"
  • It would be cool, if we could display a set of core-concepts our methodology:

    • Layered
    • Cake (as main emojii-association 🍰 )
    • Parts & Compose (🧩)
    • Sliced
    • Segments

References

Unfortunately, without any sources :(

image
image
image
image
image
image

@Postamentovich
Copy link
Member

👍

@Postamentovich Postamentovich self-assigned this Oct 27, 2021
@azinit azinit changed the title Адаптировать слоистую схему "торта" Adapt "layered-cake" scheme Oct 27, 2021
@Postamentovich Postamentovich removed their assignment Jan 25, 2022
@Postamentovich
Copy link
Member

DIAGRAM-01

@azinit
Copy link
Member Author

azinit commented Jan 25, 2022

@illright Мб поделишься мнением, как лучше схему слоистую адаптировать? 🤔

@illright
Copy link
Member

Возможно, стоит убрать из слоистой диаграммы названия непосредственных слоев (потому что их всех все равно не уместить), и сделать эту диаграмму "анатомией слоя". Еще одна причина так поступить – эта диаграмма, как и скриншот структуры директорий, немного абстрактна и отсоединена от реальных интерфейсов. Из-за этого мне кажется, что она не так полезна для понимания методологии в целом. Она полезна для понимания вложенности понятий.

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

@illright
Copy link
Member

illright commented Jan 25, 2022

Насчет диаграммы, которую @Postamentovich вкинул – во-первых, лайк, очень лаконично и современно. Во-вторых, вижу, что помимо объяснения анатомии слоя и демонстрации порядка слоев (пусть и неполного) там есть еще один "дата-поинт" – отличие слоя Shared от остальных слоев. Это полезная информация, но я не уверен, что на этой диаграмме она получает должное количество внимания. Возможно, эту информацию будет проще донести текстом в описании слоя Shared.

И насчет того, как нарисован слой Shared – у меня создается впечатление, что слой Shared состоит из слайсов, но по факту он ведь должен состоять из сегментов? Может быть, если оставлять этот слой на диаграмме, лучше будет нарисовать не круг, поделенный на 4 сектора, а концентричные круги разного диаметра?

Ах да, еще там есть сегмент components, который, кажется, должен называться ui.

@illright
Copy link
Member

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

@azinit
Copy link
Member Author

azinit commented Jan 25, 2022

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

А вот это уже боюсь будет лишнее, т.к. диаграмма должна смотреться нормально и без цветового окраса 🤔

Иначе получится что-то типо такого 😏

@illright
Copy link
Member

Еще момент. Для русской версии документации нужны русские пометки на диаграмме. Обратил на это внимание, пока пытался очистить доку от ссылок. Пусть будет "слой", "слайс", "сегмент". Названия слоев и сегментов можно оставить на английском. Если названия будут на английском, будет немало путаницы и проблем с формулировками на странице Введение.

Еще на последней версии диаграммы layers хорошо бы сменить на единственное число.

@azinit
Copy link
Member Author

azinit commented Jan 31, 2022

Еще момент. Для русской версии документации нужны русские пометки на диаграмме. Обратил на это внимание, пока пытался очистить доку от ссылок. Пусть будет "слой", "слайс", "сегмент". Названия слоев и сегментов можно оставить на английском. Если названия будут на английском, будет немало путаницы и проблем с формулировками на странице Введение.

Кажется, проблема более глобальная, и связана с локализацией)
И если выбирать между

  1. Хранить и поддерживать по две версии под каждую локаль
  2. Хранить одну версию, но использовать ее везде (english-first)

То кортима склоняется все же ко второму варианту
Т.к. под каждый язык не адаптируешься)
(и даже если адаптируешься - то потом это дело еще поддерживать надо, что проблемней)

#243

@azinit
Copy link
Member Author

azinit commented Feb 13, 2022

STATUS-UPDATE: @unordinarity По итогу запилит интерактивную схемку на подобие этой, которую можно было бы вставить на лендос/в интро

@azinit azinit changed the title Adapt "layered-cake" scheme DISCOVERY: (QUICK-PROMO) Adapt "layered-cake" scheme Jun 11, 2022
@azinit azinit closed this as completed Sep 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants