Совет для профессионалов. Ошибки: рекомендуемый инструмент для регистрации и отслеживания

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

Почему?
(Причина №1)
По моему опыту, я часто работал с технологиями, у которых очень мало документации, а иногда и вовсе нет, что оставляет вам возможность самостоятельно разбираться в некоторых частях и в результате сталкиваться с ошибками.

(Причина №2)
Отображаемые сообщения об ошибках часто расплывчаты, и сразу определить причину сложно. Отслеживание того, что вызвало ошибку и почему, заняло целые рабочие дни, чтобы выяснить, или вынудило взломать в качестве обходного пути из-за нехватки времени.

(Причина №3)
В случае, когда в качестве обходного пути применялся хак, я часто обнаруживал, что решение находится на гораздо более позднем этапе проекта. Это может быть через недели или месяцы. Точное запоминание того, что произошло, почему это произошло и шаги для воспроизведения, оказалось сложной задачей.

(Причина №4)
Ошибки, которые я видел при выполнении любого из следующих действий:
адаптация | настройка проекта на моем компьютере | любая конфигурация проекта | любая конфигурация сборки |
Документирование их важно, потому что они происходят только один раз на этом этапе, и вы можете никогда их не увидеть, пока вам не понадобится либо новый компьютер, либо настройка другого проекта. Так что наличие этой документации под рукой экономит время и предотвращает головную боль в будущем, поверьте мне. Кстати, я бы отметил шаги для всех настроек и конфигураций, потому что, опять же, когда вам нужно будет сделать это на более позднем этапе, это может быть болезненно и занимает даже у самых старших инженеров целый день или два.

Средство, которое я рекомендую
Я рекомендую использовать Confluence.

Почему?
(Причины)

Он имеет полезные шаблоны, такие как шаблон How to
вы можете сделать свои заметки модульными и развязанными, например:

Я могу создать страницу с надписью «Ошибки»
Я могу создать дочерние страницы в разделе «Ошибки», например, дочернюю страницу с надписью «Ошибки Swift».
В разделе «Ошибки Swift» я могу создать дочернюю страницу с надписью «Ошибки времени выполнения Swift», и здесь я могу создать дочерние страницы для различных ошибок времени выполнения, с которыми я сталкиваюсь.
Ошибки
-Быстрые ошибки
—Ошибки выполнения Swift
—при добавлении зависимостей проекта

Теперь я могу создать страницу с надписью Swift
Затем я создаю дочернюю страницу с надписью How to’s
Затем я создаю дочернюю страницу How to с надписью Добавление зависимостей проекта, где я перечисляю шаги для этого.
-Быстрый
—Как
— добавление зависимостей проекта

Вот интересная часть, на этой странице я могу добавить раздел на эту страницу с надписью «Ошибки, на которые следует обратить внимание и что делать, если они обнаружены», а затем вставить либо отрывок «Ошибки/.. при добавлении зависимостей проекта», либо весь страницу на эту страницу.
Любая страница может быть вставлена в несколько страниц. Теперь, если я сделаю обновление дочерней страницы «Ошибки/.. при добавлении зависимостей проекта», везде, где эта страница используется, это обновление также будет отражаться.

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

На протяжении многих лет я накапливал свои знания в области разработки программного обеспечения в Confluence. Проверьте это здесь Пожалуйста, используйте следующие кредиты
пользователь: softwareengineer@elamenterpriseltd.com
pw: Пароль@ssword*1234