Storybook

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

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

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

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

Даже сделали замечание, что я слишком много времени уделяю для второстепенной задачи :))

Кажется я не поменял арабскую раскладку...

Жопа...

Не, ну так обосраться могу только я :)))

Cпецификации

Недавно писал об опыте написания документации с помощью storybook. Почти сразу после этого проекта, пришлось писать уже спецификацию.

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

Отличие между спекой и докой в том, что спецификация — описание того, как нужно делать, а документация — описание того, что уже сделано.

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

Давайте поможем моей сестре выиграть в конкурсе, всех неравнодушных прошу проголосовать за Дагестан!

https://t.me/toktamyshevaa/3162

Заметки

У меня нет привычки писать заметки, но есть привычка проговаривать все в голове.

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

Недавно, настраивая Raycast, наткнулся на их новую фичу в последнем обновлении — Raycast Notes. Решил потестить и расписать мысли. Времени заняло не много, но это очень помогло их структурировать. Я сразу понял, какое решение лучшее в моем случае и пошел его пилить :)

Теперь постоянно юзаю заметки. Записываю все, что придет в голову. Очень советую попробовать этот метод, работает безотказно.

Вообще про raycast хочется отдельно написать, лучшее приложение, которое можно установить на мак.