Документационный инструментарий

Техническому писателю нужны инструменты для:

• разработки,

• ревью,

• хранения,

• публикации документов.

Коллаборативное редактирование переоценено.

WYSIWIG – «что видишь, то и получишь». Пример разработки md-файла в VS Code:

Концепция Docs as code:

• используем Help Authoring Tools (HATs, MadCap Flare, Docusaurus, GitBook);

• пишем / храним документы в виде Plain text (простой текст);

• используем легковесные языки разметки вроде Markdown (примеры писать можно в VSCode);

• храним документацию в системе контроля версий Git.