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

Архив

Старые идеи, инструменты и споры, которые стоит перечитывать, а не забывать.

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

Инструменты документации тогда и сейчас: что действительно изменилось

Форматы и конвейеры публикации поменялись радикально, но долговечные проблемы знакомы: контроль источника, reuse, навигация, ревью и синхронизация опубликованной информации с продуктом. Задолго до термина Docs-as-Code команды боролись с несколькими копиями исходников, повторно используемыми фрагментами, версиями руководств и вопросом, какая копия актуальна.

Редакционная техническая иллюстрация к статье: Старые вопросы о документации, которые удивительно хорошо пережили время.
Архив

Старые вопросы о документации, которые удивительно хорошо пережили время

Названия инструментов меняются быстрее редакционных проблем. Вопросы о терминологии, владении, скриншотах, reuse и ревью снова появляются в командах, потому что отражают более глубокие решения устройства системы. Инструментальный ответ изменился: общие папки уступили репозиториям и ownership rules.

Гипертекст до современных порталов документации
Архив

Гипертекст до современных порталов документации

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

Что осталось от техписа 2006 года?
Архив

Что осталось от техписа 2006 года?

Инструменты изменились радикально, но ядро профессии удивительно узнаваемо: аудитория, факты, структура, терминология и ответственность. В 2006 году технический писатель заметно чаще жил в настольных издательских системах, офисных форматах и вручную поддерживаемых help-системах.

Когда руководства поставлялись на CD
Архив

Когда руководства поставлялись на CD

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