Техническая документация, инструменты и профессия — независимый журнал
TECHWRITERS.ORG

Редактура

Статьи с меткой: Редактура

Используйте ИИ как редактора, а не как оракула
ИИ и документация

Используйте ИИ как редактора, а не как оракула

ИИ часто полезнее, когда ищет слабую структуру, неоднозначность и пропуски, чем когда ему дают роль источника истины. Отделяйте работу с языком от истины: более гладкая фраза всё равно может описывать неверное поведение.

ИИ научился писать документацию. Что теперь делать техническому писателю?
ИИ и документация

ИИ научился писать документацию. Что теперь делать техническому писателю?

За три года генеративный ИИ превратил черновик текста из дорогого результата в дешёвую операцию. Главный вопрос теперь не в том, умеет ли модель писать, а в том, кто отвечает за факты, структуру, проверку, обновление и качество документации после того, как текст стало возможно получать за минуты.

Редакционная техническая иллюстрация к статье: Осознанная практика для технического писателя: тренируйте работу, а не модные слова.
Обучение

Осознанная практика для технического писателя: тренируйте работу, а не модные слова

Читать о документации полезно, но навык быстрее растёт через повторяемые небольшие упражнения на исследование, перестройку структуры, редактуру и проверку с понятной обратной связью. «Стать лучше в техническом письме» слишком широко.

Как организовать ревью документации
Практика

Как организовать ревью документации

Процесс ревью должен показывать ответственность, сокращать ожидание и разделять фактическую, редакторскую и продуктовую проверку. Ревью документации ломается, когда непонятно, кто должен действовать дальше.

Редакторские упражнения, которые улучшают техническое письмо быстрее лишней теории
Обучение

Редакторские упражнения, которые улучшают техническое письмо быстрее лишней теории

Короткие повторяемые упражнения тренируют диагностику: поиск неоднозначности, пропущенных условий, слабой структуры и лишних слов в реальной документации. Тренируйте один дефект за раз: prerequisites, расплывчатые глаголы, терминологию, длинные предложения или отсутствие результата.