Каждый файл, о котором вам нужно знать при запуске нового проекта
Когда вы работаете над новым проектом, это может быть настолько увлекательно, что вы пропускаете техническую документацию и сразу переходите к разработке. Это создает массу головной боли в будущем с управлением разработчиком, соблюдением требований спецификации или просто успешным запуском. В этом блоге я надеюсь дать краткий обзор того, о чем следует подумать при составлении первой версии технической документации.
Выбор стека
Возможно, сейчас это не так, но язык/фреймворк, который вы выберете в начале, сформирует всю вашу архитектуру. Вы хотите использовать самую модную среду (Node JS на момент написания этой статьи) или вы хотите использовать проверенную и надежную?
Фреймворки и языки имеют разные плюсы и минусы. Некоторые из них лучше подходят для приложений, которым требуется высокий уровень параллелизма (представьте, что множество людей обмениваются сообщениями, взаимодействуют и делают запросы одновременно). С другими просто легче работать, потому что многие люди строили на их основе. Фреймворки и языки — это то, что вы должны обсудить перед разработкой. Если через несколько месяцев вы поймете, что не можете достичь метрики производительности после того, как выжимаете из своего кода все, что можете, и вам нужно изменить фреймворк, вы, по сути, начинаете снова с нуля.
Также ходят слухи, что Node JS теряет популярность, а Google GoLang на самом деле лучше работает в средах с большим числом одновременных вычислений.
Вехи
Каждая успешная сборка когда-то была разбита на этапы. Очень сложно нарисовать картинку для приложения, а потом просто начать беспорядочно хакать. Даже если ваша команда сможет это сделать, вы либо сильно потеряете в производительности, либо они вам лгут.
Надлежащая техническая документация должна разбивать приложение или систему на части размером в байт. Эти части должны включать разбивку хранилища базы данных, маршрутов и базовой архитектуры, а также операций разработчика. Размышляя о хранилище базы данных, вам нужно знать, какую информацию хранить и к какой информации обращаться, чтобы приложение функционировало. Маршруты и базовая архитектура состоят из того, какие страницы у вас будут и как люди будут на них заходить. Сейчас это может показаться не таким, но о SEO нужно думать с самого начала. Маршруты и архитектура чрезвычайно сильно влияют на SEO. Наконец, операции разработчика — это место, где будет жить ваше приложение. Большинство людей предпочитают использовать облачный сервис. Это избавляет от головной боли, связанной с управлением физическими машинами в персональном центре обработки данных.
Это было чрезвычайно краткое чтение для того, что может быть обширным документом. Если вам нужна дополнительная информация, пример или помощь в создании документа, свяжитесь со мной здесь. Не забудьте подписаться на нашу рассылку, чтобы получать эксклюзивные шаблоны и контент!
