Примите меры, чтобы не споткнуться во мраке нового проекта.

Выяснение того, с чего начать функцию, может привести к путанице.

Функции могут быть сложными для кодирования, если вы уже знакомы с проектом. Когда вы новичок в проекте, он становится еще более запутанным. Всегда есть вопросы о том, с чего начать, о проекте и о том, как фича должна работать.

Кривая обучения новой функции в новом проекте всегда высока.

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

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

Если вы не понимаете, как работает проект или что должна делать функция, вы не сможете начать.

Шаг 1. Прочтите документацию проекта.

Погружение в документацию проекта — один из лучших способов узнать о новом проекте.

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

Если проект хорошо задокументирован, в начале вы хотите сосредоточиться на следующих конкретных вещах:

  • Инструкции по началу работы
  • Документация по структуре проекта и общим шаблонам
  • Инструкции по запуску кода
  • Инструкции по запуску автоматизированных тестов
  • Любые задокументированные стандарты кода и лучшие практики

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

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

Если чего-то не хватает в документации, положитесь на свою команду, чтобы заполнить пробелы.

Шаг 2. Запустите проект.

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

Этот шаг также является отличным временем для запуска тестов проекта и просмотра их структуры (если в проекте есть автоматизированные тесты).

Шаг 3. Убедитесь, что вы понимаете требования к функциям.

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

Вы хотите определить все, что неясно в этой функции.

Спросите о любых недостающих деталях или непонятных требованиях.

Когда вы кодируете функцию, вы должны точно знать, как вы будете ее тестировать, где она находится в пользовательском интерфейсе и как она должна работать. Часто требования пишутся для разработчиков, уже знакомых с проектом. Обычно новые люди просят недостающие детали или разъяснения.

Не бойтесь выглядеть плохо, задавая вопросы. Лучше задавать вопросы заранее, чем делать неправильные предположения при кодировании.

Шаг 4. Выясните, где функция находится в коде.

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

Как и в других шагах, если вы не можете понять это самостоятельно, попросите свою команду указать вам правильное направление.

Шаг 5. Начните программировать

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

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

Многим людям трудно найти первую строку кода для написания.

Когда функция пересекает несколько слоев и может быть запущена на любом из них, выбор слоя для начала может оказаться сложной задачей. Что проще начать с базы данных или уровня данных? Или проще начать с фронтенда?

Ответ на эти вопросы будет зависеть от вас, проекта и функции.

Некоторые функции и проекты лучше подходят для запуска на одном уровне, чем на другом.

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

Используйте то, что вам удобнее, в качестве отправной точки.

Если вы действительно не уверены, с чего начать, снова обратитесь к своей команде за предложениями.

Следуя этим шагам, вы обнаружите, что запуск функций в новых проектах стал немного проще.

Вам предстоит еще многому научиться, и у вас будет много вопросов. Но, выполнив эти шаги, вы не почувствуете себя потерянным.

Есть ли у вас какие-либо другие шаги, которым вы хотели бы следовать при работе над новым проектом?

Спасибо за чтение.

Want to Connect With the Author?
If you liked this and would like to see other tips, advice, and articles from me, you can find me on most social media under @kevinhickssw.

Больше контента на plainenglish.io. Подпишитесь на нашу бесплатную еженедельную рассылку новостей. Получите эксклюзивный доступ к возможностям написания и советам в нашем сообществе Discord.