Technical Writing и документация: API docs, guides, runbooks и knowledge baseШаг 11 из 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м

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

Docs IA

Шаг 11 из 1511 минТеория

Цель

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

Как работать

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

Критерий

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

Docs IA: быстрый старт, концепции, руководства, справочник, диагностика и изменения

Опорная идея

Information architecture документации должна помогать найти ответ: quickstart, concepts, guides, reference, troubleshooting, changelog. Хорошая структура дает entry points для разных ролей и не заставляет читать весь сайт с начала.

Для образовательного портала docs должны связывать авторов, учеников, администраторов, платежи, видео и сертификаты.

Обсуждение

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

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