Где удобно вести документация по React.JS-компонентам (Google Docs не удобно)?

Question

[Alex Polyakh]

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

Answer 1

[Антон Спирин]

Все что вам надо это storybook + статическая типизация. Нет особого смысла вести отдельную документацию по компонентам.

Comments

[Александр Симонов]

... Ваш комментарий - это нечто
То есть для этих целей тянуть статическую типизацию есть смысл, а вот документацию нет?

Просто задумайтесь, что включить типизацию в проект, который работает - это не так просто как в проект, который только начинает свой путь.

Чтобы включить например typescript в проект, нужно довольно сильно поменять поток работы, вы больше не можете просто запустить всё в браузере и наслаждаться, ваш код нужно транспилировать в js. Если это flow то нужно хотя бы типы почистить. А вот описать что делает компонент где-то в git wiki - это простое и удобное решение, которое не заставляет менять что-то ВНУТРИ проекта и позволяет разделить мух и котлет

[Антон Спирин]

Просто задумайтесь, что включить типизацию в проект, который работает - это не так просто как в проект, который только начинает свой путь.

Достаточно просто как в случае с TS, так и в случае с Flow. И чем раньше это сделать, тем лучше.
А учитывая предыдущие вопросы автора, можно предположить, что проект начал свой путь недавно.

Чтобы включить например typescript в проект, нужно довольно сильно поменять поток работы, вы больше не можете просто запустить всё в браузере и наслаждаться, ваш код нужно транспилировать в js.

Вовсе нет, ТypeScript легко транспилируется налету с помощью webpack со всеми радостями вроде HMR.

А вот описать что делает компонент где-то в git wiki - это простое и удобное решение, которое не заставляет менять что-то ВНУТРИ проекта и позволяет разделить мух и котлет

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