6 подписчиков

Как я веду документацию по задаче 3/3

Раздел "вопросы" (и ответы) жизненно нужен, когда по задаче приходится что-то уточнять: где лежат данные для обработки, что означает тот или иной код ошибки, какие тулзы использовать и тд. Заполняя этот раздел, вы сохраните большую картину процесса разработки и быстрее будете приходить к решению. Пример из жизни: многие спикеры и преподаватели во время своей лекции просят слушателей свои вопросы записывать и задавать их в конце. Чаще всего бывает, что мы сами отвечаем на свои вопросы со временем.

Очень часто моя работа заключается в поиске рабочей комбинации настроек нескольких систем обработки данных. Ведение раздела с личными вопросами и ответами помогает составить мне работающий паззл из множества возможных вариантов.

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

3/3

Около минуты

23 февраля 2024