DigitableCourses
База знаний

Тема: техническое письмо

15 материалов в этой теме.

Материалы

3 на странице
Статья

RFC и проектные документы: как выносить решение на обсуждение

RFC — не описание системы, а запрос на возражения до того, как они станут дорогими: когда открыто окно для такого документа, из каких разделов он состоит, как …

#техническое письмо#документация#коммуникация
23 мин
Статья

README: первое, что видит новый человек

README отвечает на три вопроса за шестьдесят секунд — что это, как это запустить и к кому идти дальше; разбираем анатомию файла на парах «плохо / переписано», метрику …

#техническое письмо#документация#readme
22 мин
Статья

ADR: запись архитектурного решения, которая переживёт автора

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

#техническое письмо#документация#adr
17 мин