Technical Writing и документация: API docs, guides, runbooks и knowledge base

Чему вы научитесь

• Определять audience, goal, prerequisites and success criteria документа
• Различать tutorial, how-to, explanation, reference, runbook and decision record
• Писать API docs: endpoint, auth, request, response, errors, examples and versioning
• Создавать troubleshooting guides and runbooks with symptoms, checks and actions
• Настраивать docs-as-code: Markdown, review, ownership, linting and changelog

О курсе

Курс делает документацию профессиональной инженерной компетенцией. Ученик учится писать для конкретной аудитории, строить tutorials, how-to guides, conceptual docs, API reference, runbooks, troubleshooting guides, release notes and docs-as-code workflow.