Size: a a a

technicalwriters

2021 January 18

ЕБ

Елена Борисенок... in technicalwriters
Кто пишет документацию на английском  - можете дать пару ссылок на примеры работ? А то у меня ощущение, что я в своем маленьком мирке варюсь, и не факт, что делаю это правильно ))
источник

A

Aleksandra in technicalwriters
Елена Борисенок
Кто пишет документацию на английском  - можете дать пару ссылок на примеры работ? А то у меня ощущение, что я в своем маленьком мирке варюсь, и не факт, что делаю это правильно ))
Я не пишу, но видела на одном вебинаре ссылку на документацию по Git.
источник

NV

Nick Volynkin in technicalwriters
Aleksandra
Я не пишу, но видела на одном вебинаре ссылку на документацию по Git.
Как пример плохой документации? )
источник

MS

Mark Shevchik in technicalwriters
Елена Борисенок
Кто пишет документацию на английском  - можете дать пару ссылок на примеры работ? А то у меня ощущение, что я в своем маленьком мирке варюсь, и не факт, что делаю это правильно ))
источник

A

Aleksandra in technicalwriters
Nick Volynkin
Как пример плохой документации? )
Нет) наоборот
источник

ЕБ

Елена Борисенок... in technicalwriters
спасибо! то, что надо )
источник

RD

Roman Dynnik in technicalwriters
Есть ещё такая профессия - контент-архитектор ...
источник

T

Timur Minullin in technicalwriters
Здравствуйте. В confluence для версионирования текстов какие макросы используете? Кроме scroll versions. Хочу узнать какие есть ещё варианты версионирования
источник

M

Maeg in technicalwriters
Timur Minullin
Здравствуйте. В confluence для версионирования текстов какие макросы используете? Кроме scroll versions. Хочу узнать какие есть ещё варианты версионирования
Штатного версионирования обычно достаточно. Но если вы выделяете мажорные версии для публикации, то это должны делать плагины, которые обеспечивают публикацию. У Comala Publishing вроде тоже есть.
источник

ET

Eduard Tibet in technicalwriters
Roman Dynnik
Есть ещё такая профессия - контент-архитектор ...
На самом деле, в англоязычной среде это называется Information Architect (есть еще Information Developer).
источник

IS

Igor Shakhbazyan in technicalwriters
Timur Minullin
Здравствуйте. В confluence для версионирования текстов какие макросы используете? Кроме scroll versions. Хочу узнать какие есть ещё варианты версионирования
Вопрос насущный, тоже в нем заинтересован. Пока что варианты увидел Comala Publishing и Scroll Versions, но немного напрягает цена ($100 и $350 соответственно).
Штатное версионирование (т.е. история версий страницы) - это немного не то.
источник

V

Vadim in technicalwriters
Igor Shakhbazyan
Вопрос насущный, тоже в нем заинтересован. Пока что варианты увидел Comala Publishing и Scroll Versions, но немного напрягает цена ($100 и $350 соответственно).
Штатное версионирование (т.е. история версий страницы) - это немного не то.
В этих решениях читатель документации может быстро переходить по веткам? Ну то есть он читает статью из ветки 4.0, на этой же странице выбрал другую версию и попал сразу на эту же страницу в новой версии?
источник

IS

Igor Shakhbazyan in technicalwriters
Vadim
В этих решениях читатель документации может быстро переходить по веткам? Ну то есть он читает статью из ветки 4.0, на этой же странице выбрал другую версию и попал сразу на эту же страницу в новой версии?
Как вариант. Основное требование - возможность поддержки одновременно нескольких версий одной страницы в различных состояниях (открыто/закрыто), возможность публикации изменений из указанной версии с сохранением истории версий.
Кейс: разработана функциональность, по ней написана дока, но функциональность еще не в релизе, соответственно, доку еще нельзя в паблик. Тогда исправленную статью нужно придержать до выхода релиза и пролить тогда же.
Scroll Versions это умеет, но интересны альтернативные предложения.
источник

M

Maeg in technicalwriters
Igor Shakhbazyan
Как вариант. Основное требование - возможность поддержки одновременно нескольких версий одной страницы в различных состояниях (открыто/закрыто), возможность публикации изменений из указанной версии с сохранением истории версий.
Кейс: разработана функциональность, по ней написана дока, но функциональность еще не в релизе, соответственно, доку еще нельзя в паблик. Тогда исправленную статью нужно придержать до выхода релиза и пролить тогда же.
Scroll Versions это умеет, но интересны альтернативные предложения.
если сервер, то посмотрите ещё Page Branching. Соответственно, редактирование - только в бранчах, мерджить - только основные версии. Но Scroll всё же лучше, как по мне. Опять же, к нему есть прекрасный Translations
источник

IS

Igor Shakhbazyan in technicalwriters
Maeg
если сервер, то посмотрите ещё Page Branching. Соответственно, редактирование - только в бранчах, мерджить - только основные версии. Но Scroll всё же лучше, как по мне. Опять же, к нему есть прекрасный Translations
Да, серверный эдишен. Спасибо, посмотрю!
источник

RD

Roman Dynnik in technicalwriters
Eduard Tibet
На самом деле, в англоязычной среде это называется Information Architect (есть еще Information Developer).
Ввиду путаницы лучше не употреблять information architect в этом контексте.
Под Information Architect теперь понимается другое - роль связанная с master data management, архитектурой данных, ECM и CMS системами и т п.
источник

RD

Roman Dynnik in technicalwriters
Так например люди указанной специализации, например, в ibm стали называться content strategist, content architect.
источник
2021 January 19

T

Timur Minullin in technicalwriters
Timur Minullin
Здравствуйте. В confluence для версионирования текстов какие макросы используете? Кроме scroll versions. Хочу узнать какие есть ещё варианты версионирования
Резюмирую:
1. Штатное версионирование(история страниц)
2. Camola Publishing
3. Scroll versions, можно использовать с Translation
4. Page branching, если сервер.
Всем спасибо!
источник

ДЧ

Дарья Чернавина... in technicalwriters
Наблюдение: поздравляли сегодня аналитика. Руководитель отметил, что она первая сделала документацию на сайт. Анализ вакансий на HH в регионах показал, что почти не ищут чистого техписа, всегда аналитик в функциями техписа 😐 Сижу, думаю.
источник

BF

Bobba Fett in technicalwriters
Разработчик: — Я закончил проект, он готов к тестированию

Тестировщик: — Я всё протестировал, в конечном продукте багов нет

Техпис: — Я всё описал, пользователь точно разберётся

Пользователь: *не читает документацию, интуитивно понятно же*
источник