Skip to content
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

README: Overview (concepts) #94

Closed
3 tasks done
azinit opened this issue Apr 15, 2021 · 4 comments · Fixed by #116
Closed
3 tasks done

README: Overview (concepts) #94

azinit opened this issue Apr 15, 2021 · 4 comments · Fixed by #116
Assignees
Projects

Comments

@azinit
Copy link
Member

azinit commented Apr 15, 2021

Overview - секция с базовым прогоном по методологии и описанием "а что здесь есть"

Overview/Concepts - подсекция, объясняющая ключевые концепции методологии, о которых точно надо знать "при первом приближении", и которые больше раскроют философию методологии

Content

На свой вкус, но описал здесь свое мнение

Имхо должно быть про Public API, Isolation - и возможно что-то еще

Но не слишком подробно - ибо у нас отдельные статьи есть на это (а некоторые "в планах")

Дополнительно

  • Максимально заинтересовать целевого читателя, чтобы он пошел дальше

    • Он должен понять - что методология решает его проблему
    • Т.е. мы должны нашим ридми - "продать методологию", а потом уже погружаться в детали
  • По возможности - переиспользовать/доработать то что уже есть

  • По возможности и необходимости - референсится на имеющиеся статьи в доке

Материалы для задачи

  • Глянь текущие дискуссии (мб что выцепишь)
  • Глянь папку /concepts/ в нашей текущей доке (многое оттуда пойдет, но можешь и отсеять, оставив "ключевое"
  • Можешь глянуть "Требования к архитектуре" - мб там тоже что-то выцепить можно
@azinit azinit added this to To do in MVP via automation Apr 15, 2021
@azinit
Copy link
Member Author

azinit commented Apr 15, 2021

image

@azinit azinit moved this from To do to In progress in MVP Apr 15, 2021
@azinit
Copy link
Member Author

azinit commented Apr 21, 2021

Я бы кста возможно что-то из этого заюзал в концепциях тож

image

@azinit
Copy link
Member Author

azinit commented Apr 21, 2021

Можешь глянуть, как в PR (#101 ) расписал

image

@azinit
Copy link
Member Author

azinit commented May 5, 2021

@binjospookie начни добивать задачу в каком-то виде пож

Или хотя бы наметь - какие именно концепции должны быть затронуты в этом разделе

@azinit azinit assigned azinit and unassigned binjospookie May 10, 2021
@azinit azinit linked a pull request May 13, 2021 that will close this issue
3 tasks
@azinit azinit moved this from In progress to Review in progress in MVP May 13, 2021
MVP automation moved this from Review in progress to Done May 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
MVP
Done
Development

Successfully merging a pull request may close this issue.

2 participants