Документирование
Мы завершаем разработку проекта и это сопровождается написанием кучи разной документации, в чем я захотел получить опыт.
Я понял, почему написание документов истощает больше, чем написание кода. Если я чего-то не знаю, как делают люди в java/js/ts/etc (я много про что не знаю в местном стеке) я всегда могу найти верный способ и убедиться, что он работает, просто запустив и написав тесты. (Кстати, имея поисковик по всему коду Амазона, задача упрощается, так как весь код по крайне мере рабочий и минимально проревьюен, и его очень много.) С документами на человеческом языке все сложно. Есть гайды по структуре, наводящие вопросы, но все равно остаётся много сомнений в мелочах, и на ревью всплывают вопросы, которые почему-то не всплывали в процессе написания. Нет stackexchange, из которого можно накопипастить готовый документ. Возможно, со временем появятся системы, которые смогут проводить первичное ревью документов, хотя бы проверяя постановку задачи и наличие фактов, которые, предположительно, ее решают, их возможно все равно будут скромными долгое время.
А пока я не знаю способа лучше, чем просто писать как можно больше, оперировать гайдами и отправлять на ревью, выстраивая подобную систему в себе.
Мы завершаем разработку проекта и это сопровождается написанием кучи разной документации, в чем я захотел получить опыт.
Я понял, почему написание документов истощает больше, чем написание кода. Если я чего-то не знаю, как делают люди в java/js/ts/etc (я много про что не знаю в местном стеке) я всегда могу найти верный способ и убедиться, что он работает, просто запустив и написав тесты. (Кстати, имея поисковик по всему коду Амазона, задача упрощается, так как весь код по крайне мере рабочий и минимально проревьюен, и его очень много.) С документами на человеческом языке все сложно. Есть гайды по структуре, наводящие вопросы, но все равно остаётся много сомнений в мелочах, и на ревью всплывают вопросы, которые почему-то не всплывали в процессе написания. Нет stackexchange, из которого можно накопипастить готовый документ. Возможно, со временем появятся системы, которые смогут проводить первичное ревью документов, хотя бы проверяя постановку задачи и наличие фактов, которые, предположительно, ее решают, их возможно все равно будут скромными долгое время.
А пока я не знаю способа лучше, чем просто писать как можно больше, оперировать гайдами и отправлять на ревью, выстраивая подобную систему в себе.