Техническая документация
README, tutorial, reference, ADR, runbook и документация API.
README, tutorial, reference, ADR, runbook и документация API.
Учитесь по порядку: прочитайте объяснение, решите задачу до раскрытия ответа и проверьте ход рассуждений. Затем выполните лабораторную работу курса. В справочнике собраны все разделы и пример с пояснениями; переходить на другие сайты для чтения материала не требуется. Для выполнения кода или работы с оборудованием нужна указанная учебная среда. Оценка часов включает самостоятельную практику и итоговый проект, а не только чтение.
Что вы разберёте
1Аудитория, задача и information architectureОбъяснение и задача с ответом2README и quick startОбъяснение и задача с ответом3Tutorial, how-to и explanationОбъяснение и задача с ответом4Reference и API documentationОбъяснение и задача с ответом5ADR, runbook и troubleshootingОбъяснение и задача с ответом6Docs-as-code, review и usability testОбъяснение и задача с ответомУчитесь с проверкой результата
Сначала решайте задачи самостоятельно, затем сравнивайте рассуждение с разбором. Итоговая работа проверяет применение знаний; отметка урока не является автоматической аттестацией.
Подготовка, пример и итоговая работа →