Быстро управляйте своими проектами из редактора кода
У каждого проекта есть дорожная карта, будь то небольшое любительское программное обеспечение или сложная кодовая база. Вы начинаете с разработки аспектов высокого уровня, а затем сосредотачиваетесь на деталях реализации, разбивая проект на более мелкие задачи, которые необходимо выполнять шаг за шагом.
При разработке полезно отслеживать свой прогресс и то, что нужно делать дальше, что приводит к большему пониманию всего проекта. Помня обо всех микрошагах, вы можете сделать лучший выбор реализации, который не повлияет на разработку в будущем, поскольку вам нужно будет переписать части кода, потому что они написаны таким образом, что не позволяют вам достичь вашей цели. эффективно.
Есть много способов работать с дорожными картами, микрошагами и отслеживанием прогресса. В этой статье я покажу вам формат файла TODO.md и объясню, почему вы должны его использовать.
Что такое TODO.md?
TODO.md — это простой и легкий формат, основанный на широко используемом формате файлов Markdown. Файл TODO.md содержит задачи проекта, организованные в несколько разделов и подзадач. Хранение файла TODO.md отлично подходит для разработчиков, чтобы наметить план проекта и отслеживать прогресс, а также для внешних зрителей, чтобы узнать о планах проекта и текущем статусе.
Допустим, вы давно не работали над кодовой базой. Может быть трудно вспомнить, что уже сделано и что предстоит сделать дальше. В этом случае вам часто нужно просмотреть историю коммитов и изучить код в поисках какого-нибудь скрытого TODO комментария или запустить программу, чтобы узнать, нет ли ошибки, которую нужно исправить.
Более того, если вы планируете внести свой вклад в проект, полезно иметь некоторое представление о текущем статусе: возможные ошибки, которые необходимо исправить, функции, которые необходимо реализовать, запланированные рефакторинги и т. д. Принять участие сложно, если у вас нет публичной доступный план или дорожная карта.
Формат TODO.md
Хотя вы можете использовать свой собственный стиль TODO, рекомендуется сохранять стандартизированные файлы для ясности и совместимости с автоматизированными инструментами.
Файл TODO.md обычно помещается в корневую папку проекта для быстрого доступа. Файл TODO.md разделен на разделы. Каждый раздел содержит встроенные задачи, сгруппированные по теме, статусу выполнения или другим критериям. Вы также можете включить название проекта и краткое описание, если его еще нет в файле README.md.
Как видите, формат — это просто базовое подмножество Markdown. Ниже вы можете увидеть результат:
Теперь каждый может мельком взглянуть на ваш TODO.md и понять суть происходящего. Используйте файл TODO.md в сочетании с README.md для презентации и DOCS.md для справки, чтобы сделать ваш проект полностью понятным для всех, просто прочитав несколько файлов Markdown.
Кроме того, есть полезное расширение VSCode под названием Todo Kanban Board, которое отображает доску задач из файла TODO.md и позволяет вам управлять своими задачами с помощью минималистского графического интерфейса непосредственно на вкладке VSCode. Вот краткая визуальная демонстрация:
Другие инструменты управления
Существует множество других инструментов управления проектами, часто гораздо более функциональных и многофункциональных. Более продвинутая альтернатива, поддерживающая передовые функции, такие как интеграция с календарем для сроков, уведомления в реальном времени и панель статистики, рекомендуется для крупномасштабных проектов, в которых несколько человек работают одновременно.
Однако в большинстве случаев предпочтение отдается более минималистскому подходу. Хранение файла TODO.md не требует первоначальных накладных расходов, что отлично подходит для запуска проекта, который не станет следующей многомиллиардной услугой.
Добавление строки уценки часто является самым быстрым и дешевым вариантом, не требующим входа в какое-либо онлайн-приложение для управления, которое также не будет доступно в автономном режиме. Помимо этого, TODO.md легко переносим, поскольку представляет собой небольшой текстовый файл.
Так как TODO.md находится в корне вашего проекта, он легко доступен любому, а не только его разработчикам и менеджерам. Это отлично подходит для проектов с открытым исходным кодом, поскольку заинтересованным людям будет проще участвовать и вносить свой вклад. Кроме того, с Git вы бесплатно получаете решения для управления версиями и параллелизма.
Заключительные слова
Подводя итог, вы всегда должны включать TODO.md в корень вашего проекта. Это простой и эффективный способ управления процессом разработки, не требующий дополнительного программного обеспечения или услуг. Это полезно для команд и отдельных программистов, чтобы сосредоточиться на целях и отслеживать прогресс.
Напомним, вот синтетический список преимуществ хранения файла TODO.md:
Надеюсь, вам понравилась эта статья. Если вам есть, что добавить, поделитесь своими мыслями в комментариях. Спасибо за прочтение!
Если вы заинтересованы в изучении навыков, чтобы стать лучшим разработчиком программного обеспечения, вам следует взглянуть на эту историю ниже:
