Предстоит сложный проект, который буду пилить в одиночку. Хотелось бы предусмотреть документацию на случай, если в будущем к проекту подключат еще кого-нибудь, чтобы коллега мог почитать мои каталогизированные заметки и сходу въехать во внутреннюю логику и архитектуру приложения.
Чтобы вы посоветовали для ведения документации? Не для хранения кода, а именно для ведения обычной текстовый документации в виде структурированных заметок.
P. S. Планирую сделать простой сайт на базе CMS Joomla и туда заливать все свои заметки, но может есть варианты получше? Писать всё в комментарии внутри кода не вариант, слишком много комментариев выйдет тогда) Да и примеры запросов к API так не приложишь.
Да, именно, я так и подумал, когда задавал вопрос - ну не может не существовать узкоспециализированных решений конкретно для хранения документации. Подожду еще ответов, на след. неделе отмечу ваш ответ, как решение.
RxR, ааа, понял. Нет, с, оформлением проблем нет, в крайнем случае просто создам сайт и буду всю инфу заливать туда, но вдруг есть узкоспециализированные сервисы или движки именно под хранение документации для кода?
Очевидно, что писать сложный проект на ЖСе не самая лучшая идея.
Пиши на typescript'e и понадобится намного меньше документации и въехать в проект можно будет намного проще и быстрее. Про упрощения поиска ошибок самому вообще молчу.
Надим Закиров, вообще ts не для аккуратности, а для строгой типизации, удобного интелисенс, багфиксинга и чего-то еще более удобен. Ошибки в тс ищутся проще.
Надим Закиров, + ооп & модули простые и удобные. После TS не сможешь писать на JS, это по ощущениям будет как по городу передвигаться ползая на животе. Once you go TS you never go back
Надим Закиров, интересно, каким образом "трудолюие и аккуратность" спасёт тебя от тех же больших джейсонов с приличной вложенностью? Будешь каждый раз бегать в документацию, проверяя правильность пути к параметру?
ТС позволяет выявлять большинство серьёзных и несерьёзных ошибок ещё ДО запуска программы. И чем больше кода и сложнее функции, тем больше преимуществ даёт тс.
WbICHA, стоит отметить, что скорость разработки на тс прямо пропорциональна объему кода, а у жс обратно пропорциональна, мб экспоненциально - все же сама суть. Если писать небольшой компонент, например батн, на реакте и тс, то выйдет дороже, чем написать его на жс.
RxR, безусловно, писать что-то небольшое и простое на жс существенно быстрее, чем на тс. Но в данном случае автор говорит как минимум о сложном проекте.
WbICHA, ну, сильно больших объектов не предвидится, а несколько уровней логирования позволит мне легко видеть любые возможные ошибки. Меня полностью устраивает JS.
WbICHA, возможно я когда-нибудь и начну использовать TypeScript, но для этого у меня должна возникнуть реальная необходимость: чтобы пиля очередной заказ я внезапно понял, что вот здесь я мог бы срезать путь и ускорить разработку, если бы использовал определённый инструмент. Пока такого понимания нет - TypeScript мне не нужен.
WbICHA, интуиция) Просто однажды понимаешь, что то что ты делаешь можно автоматизировать, ускорить, оптимизировать определенным образом и ну не может не быть инструмента (велосипеда) для этого. Короче, у меня так сто раз было, поэтому я и верю, что в нужный момент понимание это у меня появиться)
И еще учитывай вот какой момент - бессмысленно новичку предлагать использовать продвинутые методы программирования, пока уровень его компетенции не превысит определённую планку. По сравнению с профи, я тот самый новичок. Когда придёт время переходить на крутые и сложные фреймворки я это пойму, для меня это станет как ясный день. Ну а пока что я просто нарабатываю опыт и набиваю шишки)
Ты что-то перебарщиваешь. У меня уже через 6 часов кодинга мозги в труху, а 10 часов это гарантированное нервное истощение от которого придется неделю отходить. В день 3 - 4 часа это самое то.
Насчет конкуренции, как у юристов - не думаю. Юристом может стать каждый, а вот программистом отнюдь нет, хотя конечно множество онлайн курсов утверждает обратное)
RxR, но отнюдь не любой им станет, даже в случае успешного прохождения онлайн курсов, так как разным людям нужно разное кол-во усилий для осознания и понимания одних и тех же вещей. Иными словами, многим будет чересчур сложно освоить программирование, отнюдь не невозможно - просто потребует неоправданного много усилий. Соответственно, если мы даем оценку полагаясь именно на соотношение усилия / результат, то сами понимайте: большинство кому не дается предмет, в процессе просто опустят руки и правильно сделают.
P. S. Где-то я видел исследование, что едва ли 1 / 5 учеников онлайн школ работают по профессии. Печальные цифры и хорошо показывают, что отнюдь не любой, отнюдь...
программистом стать может любой, особенно на js. Я знаю много не особо умных кто на нем пишет.
RxR, трейни/джуном, конечно, может стать каждый, но мы же не только о них говорим. Трейни/джунов уже сейчас как грязи, но толковых хрен найдёшь, а вот мидл+ уже проблема, их нехватает и вряд ли что-то кардинально изменится за 5 и даже 10 лет.
