Благодарю, изучу

Я использую MadCap Flare в последнее время дня изготовления красивых пдф. Для онлайн документации переключился на генераторы статических сайтов.

Из минусов, которые я чаще всего слышу о мэдкепе, что он дорогой и только под Виндоус

Спасибо. Можно использовать MadCap для веб-версии справки?

Да, это же single source. Из одного источника можно собирать пдф и онлайн справку

Привет! А какоц опыт работы с XMetaL? Использует DITA Extensions и DITA OT. Исходники в xml, есть визуальный редактор с подсвеченными тегами. Single source. На выходе у нас pdf и html. Много переиспользования кусков текста/топиков между документами. Переменные и всякие legal страницы, задаются централизованно. Также позволяет централизованно задавать требования к форматированию разных видов топиков, к наименованию. (Актуально для больших распределенных команд.)

Иногда я грущу, когда у меня задание поменять пару слов, а нужно развернуть вот это все, не мгновенно найти тему и место, потом генерить и выкладывать нов. документ. В Ворде ой как проще)) но html из него не генерится.

Радует чужой положительный опыт с аскидок. Год назад я написала на нем документ с несколькими инклудами. проверяла  по превью в хроме (есть плагин - здесь подскащали, возможно, Андрей Е.). До генерации билдов дело не дошло. До публикации тоже. Писала в notepad++ Теперь чувствую себя ослом - видя, что другие пользуются ide. в общем, аскидок хорош. не помню вообще никаких ограничений, чего не удалось бы реализовать в плане структуры. (учить их хелп надо, да.)

Чем мне не нравится html- продукция HAT’ов (XMetaL туда же, H&M) - это топорный вид этих страниц. Мы все читаем веб-страницы, состоящие из множества интерактивных блоков. А тут такая монолитная портянка (другого html output у себя по рабботе в двух местах не видела). Да, можно css улучшить. Но хочется именно полноценного сайта, портала. Поэтому теоретически я - за всякие Jekyll.

Еще вопрос, как вы относитесь к URL веб-справки. Для меня это часть веб-интерфейса. Хотелось бы короткие урлы, аккуратно названные файлы, без нижних подчеркиваний, без CamelCase и т.п. Но у нас есть жесткие требования к наименованию файлов, папок (все это уходит в структуру урла, например, так может быть: www.xyz.com/ProductName/En_US/help/help/Internal_Folder_Name_EN/xxxx_management/t_create_new_subscription.html)
Мой внутренний перфекционист воет при виде такого, но что-либо менять запретили.

Но! Есь еще одна надежда))) Должны быть какие-то движки, которые преобразуют структуру вложенных папок с файлами в более «юзабильную» структуру итогового сайта. Не слышали о таком?

По моим предположениям, логика должна быть, как в эндпоцнтах АПИ: они не копируют структуру данных в БД, это некоторая абстракция, призванная сделать пользование этими URL’ами интуитивно понятными и предсказуемым. (кст, в неоулдскульных веб-сервисах урл млжно использовать для навигации по вкладкам, модификации поисковых запросов.) на фоне всего этого веб-справка из HAT (но, возможно, и из аскидок+генератор сайтов - примеров не видела) выглядит отсталой и неполнофункциональной. бывает по-другому?

т.е. как делают «кульные» урлы, где нет ничего лишнего, «подкапотного»?
например, www.xyz.com/FAQ/how-to-kill-yourself-remporarily.html

Вместо MadCap за 100 уе в месяц я бы купил HelpandManual за 500 пожизненно)

Кто тут интересовался клавиатурами или присматривал себе что-то. Хорошие обзоры классических механик от классного чувака: https://www.youtube.com/user/Chyrosran22/videos М.б. и для себя что-то найдете :)

Всем привет! А ранее тут обсуждали вопрос феминитивов для "технического писателя"? Поиск вроде не дал результатов. Возможно, плохо искал.
Вот как будет: техническая писательница, документаторша, инженерка по разработке документации? 😉

Пока это не зафиксировано в словарях, спросите конкретную даму, как она хочет, чтобы её называли.

С козырей решили зайти, вбросить? ;)

Пятница...

Кстати, действительно призадумался как будет на украинском звучать должность тех писательницы, если уж на то пошло... Один из вариантов тэхнiчна докумэнткыня. На русском — писателька, как вариант.
По-моему, очень прогрессивно, в ногу со временем.

Пятничная тема.
Интерес для звучания представляют, на мой не претендующий на общность взгляд, слова иностранного происхождения (н-р, масон) :)

Прикольно я когда начал изучать испанский, сразу спросил как будет технический писатель, ответили так, насколько правильно не могу сказать: técnico de escritor

Escritor/a tecnico/a

Дама хочет, чтобы её называли госпожой 🤣