Аудитория
Уточнить знания и задачи читателя.
Составление технической документации
Объясните устройство или использование системы с учётом задачи читателя.
В чём состоит навык
Составление технической документации — подготовка структурированных сведений о системе, продукте или процессе для определённой аудитории.
Где пригодится
Структура
Разделить описание, требования и инструкции.
Проверка
Сверить текст с работой системы.
Подготовка, навыки и инструменты
Определите читателя, его задачу и достоверные источники сведений.
Связанные навыки
Связанные инструменты
Курсы для развития навыка «Составление технической документации»
На KURSEZ пока не добавлены страницы курсов для развития этого навыка. Когда они появятся, здесь можно будет изучить и сравнить программы.
Что важно знать о навыке «Составление технической документации»
Техническая документация может описывать устройство системы, требования, интерфейс или последовательность действий. Её структура зависит от того, кто будет пользоваться материалом и что читателю нужно сделать.
Хорошая инструкция объясняет необходимые предпосылки и не предполагает у читателя знаний, которых у него может не быть. Описанные шаги и примеры стоит проверять вместе со специалистами и обновлять при изменении системы.
Напишите учебную инструкцию для одной функции вымышленного приложения. Укажите аудиторию и условия начала работы, затем предложите коллеге проверить последовательность шагов.
Что посмотреть дальше
Навыки, которые можно проверить
Откройте каталог навыков и найдите материалы по интересующей вас задаче.
ОткрытьMicrosoft Word
Узнайте об инструменте и связанных с ним материалах KURSEZ.
ОткрытьСоздание проектной документации
Узнайте о связанном навыке, его применении и обучении.
Открыть