3-4 строчки на контрол. че там писать-то

контекст к окнам визардов обычно не пишется

так что это по сути - все окна натроек, окна отчетов /репортов

это если просто всплывающая подсказка. А я лежу в сторону открытия полноценной по F1

окна алертов, если там нужно какое-то децствие

почему? это полноценная страница, где описаны все контролы окна сверху вниз, слева-направо.., все графы, все панели, их там может быть хоть три десятка на этой странице, просто на каждый описание укладывается в 3-4 строчки

она открывается по F1

для каждого окна своя

Это очень частный случай решения задачи. Необязательно делать одну страницу про все элементы интерфейса.

про все элементы интерфейса в конкретном окне. а не вообще про все в продукте. а какой тогда общий случай контекстной справки?

Потом, мы не знаем, о каком продукте речь и в какой среде он работает. Это может быть сайт, CLI, приборная панель в автомобиле. Там нет кнопки F1.

ну судя по всему есть, коллега упоминала :))

Кто-нибудь занимался тем чтобы контент на asciidoc, хранящийся в git как то приземлялся (синхронизировался) в confluence?

А чем особо отличается тех райтер который пишет для клиентов компании документацию (пользователей интерфейса и апи)
И тех райтер который пишет для разработчиков (только внутренняя документация)

Ну понимаю что аудитория и инструменты разные, просто не слышала никогда о втором типе. И вот интересно они делают, на практике это один  и тот же человек или разные в разных командах?

Второй должен быть хотя бы немного разработчиком.

Ну это понятно, что должен больше понимать все процессы разработки

То есть на практике это разные люди и требуемые навыки в итоге разные?

На каком этапе развития компании интересно добавляют второго и кто писал документацию до этого (или ее не писали))

Насколько я знаю, писатели SDK стоит дороже. НО! Не всякий писатель SDK захочет писать для простых пользователей.

в данном случае дешевле даже) вот и интересно стало про ценность

Кажется, что контекстная справка — в известной степени атавизм, идущий корнями к Click here to begin, Clippy и Microsoft Bob. Решение — хорошие UI-тексты + внешняя задачно-ориентированная справка с поиском и морфологией, а не тупой токенизацией.

Вместе с тем, анимация и ActiveX в помощниках MSFT для 2002 года были шикарны...

tooltips, вызов страницы хелпа? Если вопрос не о тех. реализации, а «надо ли», то могу поделиться недавним.

В прошлом проекте было несложно и недолго выбрать проблемные настройки и написать толкования к ним, а вот задача на фронтэндера их встроить в интерфейс выглядела для некоторых менеджеров «неподъемной». (ятакнедумаю)

С другой стороны, те же менеджеры очень хотели, чтобы я написала тему в хелпе с объяснением, как регистрироваться. В итоге оказалось оптимально сначала дополнить старые тултипы на странице регистрации: по некоторым полям было много вопросов от клиентов из другого региона (другие условия для них, чем для основного региона). Техподдержка рассказала, что нужно делать этим юзерам.
Тему в хелпе «Как регистрироваться» тоже написала; она как-то будет открываться с той веб-страницы. Изначально эта задача казалась идиотской, но в итоге вышла полезная статья. Помогла ее сделать такой 1) инфо о затруднениях юзеров, 2) инфо о дальнейших шагах (где будут отображаться заполненные данные и что можно будет донастроить для допзадач).


Есть также мнение, что тултипы - это такой костыль, и без них должно быть все понятно. (я -за.) но сделать такой интерфейс иногда требует чрезмерных усилий...

Давно, в Доктор Веб, мы писали подсказки к скриншотам в темах справки в Help&Manual, а разработчики как-то сами брали эти строки (по ID) и встраивали в интерфейс.

А в недавнем проекте тексты подсказок хранились вместе с другими текстовыми строками в файлах языковых ресурсов (и подлежали локализации). Добиться доступа к ним было не оч легко, но, оказывается, даже в Амазон разработчики не очень хотели пускать техписов в свои файлы, но понемногу расслабили булки (никто не косячил, работа по правке тестов ui ускорилась).

Я делала то же самое (правила сама яз. ресурсы) в Доктор Веб еще в 2007: продвинутые разработчики были)))