Technical Writing и документация: API docs, guides, runbooks и knowledge baseШаг 14 из 15 · 0% пройдено

1. Как учиться на этом курсе

Карта пониманияopen8м Что рисовать и фиксироватьopen8м Ритм практики и повторенияopen8м Проверка учебного маршрутаopen10м

2. Профессиональный практикум: проект, качество и портфолио

От требования к тестуopen14м Архитектура вместо набора синтаксиса14м

3. Атлас программных моделей: данные, архитектура, API и тесты

Поток данных и состояниеopen15м API и база данных16м Качество: тест, review, refactor, release14м

4. Структура документации

Audience и цельopen10м Docs IAopen11м Практика: структураopen13м

5. API docs и docs-as-code

API referenceopen11м Docs-as-codeopen10м Практика: API docsopen14м

API docs и docs-as-code

Docs-as-code

Шаг 14 из 1510 минТеория

Цель

Понять основной механизм темы «Docs-as-code» без заучивания отдельных терминов.

Как работать

Прочитайте блок один раз целиком, затем вернитесь к схеме или примеру и перескажите идею своими словами.

Критерий

Сформулированное правило, пример применения и одно ограничение метода.

Docs-as-code workflow: документация проходит review и публикуется вместе с изменением

Опорная идея

Docs-as-code означает, что документация живет рядом с кодом: Markdown, review, ownership, linting, previews and changelog. Документ меняется вместе с функцией, а не через месяц после релиза. Это особенно важно для API, runbooks and deployment guides.

Документация становится частью definition of done: без понятного описания изменение не завершено.

Обсуждение

Войдите, чтобы участвовать в обсуждении.

Пока нет сообщений.