Firniara (Все сообщения пользователя)

Внимание! У нас сбои с почтовым сервером! Если не пришло письмо о регистрации или смене пароля напишите нам на info@techwriters.ru! 
@twriters
 obmen_soobsheniyami.pngчат для технических писателей в Telegram

 Зарегистрируйтесь
Выбрать дату в календареВыбрать дату в календаре

Страницы: 1
контуры кнопок, Как обвести кнопки
 
я вообще использую Snaggit, ни разу не использовала встроенное приложение в H&M...
Преобразование тоглов в заголовки при публикации в PDF
 
нумерованные заголовки в PDF - имеется в виду как новые подразделы дока?

Если так, то можно сделать обычный список в заголовке тогла, но он все равно не будет считать это отдельным разделом и не создаст на него ссылку в содержании.
Проблемы с кодировкой в Help&Manual 7, Решаем проблему с кодировкой в HM
 
В общем я получила сегодня ответ от разработчика. Оставлю здесь, если вдруг кому-то понадобится.

Если вкратце, то надо:

Проверить настройки для встраиваемых шрифтов (Font Embedding): Configuration > Publishing options > PDF > Font Embedding. Опция "Export all text as glyphs" должна быть без галочки, и проверить что в списке нет исключаемых шрифтов. Если это не помогает, то это означает, что в тексте есть символы, которые не включены в используемые вами шрифты. Поэтому Windows просто заменяет текст глифами.

Чтобы не менять все шрифты проекта, нужно выбрать в поле Font mode: Embed CID Fonts. Если это не помогло, то нужно поставить Type3 Fonts.  Type3 всегда работает, но текст будет не очень "четкий" при использовании зума.

Дополнительно можно проверить настройки драйвера принтера, т.к. H&M использует драйвер принтера для генерации PDF файлов (View > Program Options > PDF Export). По умолчанию H&M использует screen device driver, но качество PDF будет лучше, если указать конкретный драйвер. Тут важное примечание, что не надо использовать такие "PDF printer drivers" как Adobe Distiller, они работают некорректно и это "контр-продуктивно" (по словам разработчика).

Более подробная информация на официальном форуме H&M в моем посте: Search in PDFs doesn't work (wrong encoding?). (Версия H&M - 7.5.4)

Мне помогло решение указать Font mode: Embed CID Fonts. Однако я и драйвер для принтера на всякий случай тоже указала.
Изменено: Firniara - 13.01.2022 18:43:48
Поиск по статьям работает непредсказуемо
 
есть одно общее содержание - самое первое, остальные считаются дополнительными. И если топики берутся и перемещаются из общего TOC в другие TOC, то поиск идет через общий TOC.
Как в Help&Manual сделать разделение web справки на версии, Есть несколько версий описания, необходимо выводить ту версию справки, которая выбрана пользователем.
 
Не встречала ни у кого подобных кейсов. Локально я раньше хранила у себя разные версии веб справок, но места занимает много и в итоге мы отказались вообще хранить. Как вариант могу предложить вести PDF версии документации и просто подкладывать их на актуальную веб справку для скачивания.
Изменено: Firniara - 12.01.2022 20:21:50
Стиль отображения иконок ТОС
 
Знаю только для HTML. Делается это в шаблоне HTML (например example.hmskin):

Чтобы изменить css для TOC (содержания), открываем свой example.hmskin. Далее Configurations > Publishing Options > Webhelp > Table of Contents. И в поле HTML Source добавляем код, у меня это выгдлядит так:



Если надо добавить новые иконки, то сначала надо добавить их в Baggage шаблона (example.hmskin): Project Files > Baggage Files, а затем прописать их в Configurations > Publishing Options > Webhelp > Navigation > Icons in Table of contents: Use custom icons.
Полоса прокрутки в содержании WebHelp
 
Надо смотреть, я так сходу не скажу, что конкретно надо поменять
Описание постановок функций ПО, бестпрактикс и не только
 
Универсальных шаблонов нет. Каждый использует какие-то свои, устоявшиеся со временем стандарты описания, подходящие под стилистику дока. Я как правило смотрю как пишется документация у других компаний, в интернете полно доков разных приложений с описаниями, и выбираю самые интересные. И следую правилу, что не надо описывать функции, надо описывать процедуры как их использовать.

+ есть рекомендации, множество книг (моя любимая How to write the f*cking manual (англоязычная))
вот к примеру недавний доклад про проблему документации https://github.com/docops-hq/conf/blob/master/highload/19/siberia/docs.md
Полоса прокрутки в содержании WebHelp
 
пробывали ковыряться в css содержания?
Полоса прокрутки в содержании WebHelp
 
В настройках шаблонов (или проекта) есть галочка Automatically collapse unfocused entries. Если эта опция активирована, то хелп будет "скрывать" неактивные разделы с подразделами, и показывать выбранные разделы с подразделами. Следовательно, если в одном разделе много подразделов, а в другом мало, то полоса прокрутки будет то появляться, то исчезать. Все логично. Галочку можно убрать:

Configuration > Publishing options > Webhelp > Navigation:

Automatically collapse unfocused entries

А ну и в зависимости от количества подразделов внутри разделов, подразделов внутри подразделов, может появляться полоса прокрутки снизу. Это можно решить в css для содержания.
Изменено: Firniara - 23.05.2019 18:45:20
Стили имиджей указываются в дюймах, "Мылят" картинки
 
Ну вообще странно. Картинки в H&M как правило в пикселях (px). По крайней мере у меня в настройках отображается так:
<image src="btn.png" scale="15.00%" width="113" height="23" styleclass="Image Caption">

Inches есть в стилях, в настройках параграфа ( Paragraph Settings ), где указываются отступы. И почему-то когда меняешь там Inches на Centimeters, жмешь Ok, потом снова открываешь параметры параграфа, все равно отступы показываются в дюймах (видимо по умолчанию).

Попробуй обновиться, уже есть 7.5.0
Изменено: Firniara - 07.05.2019 11:49:02
Копирование фрагментов чужих инструкций или ссылки на чужие инструкции?, Пользователи не любят ссылки на другие документы
 
если начальство требует, тут к сожалению ничем не помочь.

Наверно стоит обяснить начальству, что документация это отдельный продукт, который стоит денег и времени. Копирование "чужой документации" отнимает время на разработку и улучшение собственной документации. В связи с этим качество документации по вашему продукту может пострадать из-за сокращенных сроков разработки (допустим описание будет неполным или непонятным для пользователя, могут даже появиться банальные текстовые и смысловые ошибки - что может даже привести к прекращению использования вашего продукта). И как результат, сроки разработки и стоимость документации увеличиваются. Ну и плюс ко всему, ты будешь виновата, если не успеешь в установленные сроки.
Копирование фрагментов чужих инструкций или ссылки на чужие инструкции?, Пользователи не любят ссылки на другие документы
 
у нас такая логика - все что не относится к нашему ПО - смотрите гугл
ссылка на пункт
 
Глобальная переменная <%TARGETTITLE%> помогает ссылаться на названия разделов, если они постоянно меняются. Нумерация разделов/заголовков появляется только при публикации дока. Не уверена, что есть возможность ссылаться на номер раздела как в ворде. Так что врать не буду, сама не знаю. Рекомендую порыться тут https://www.helpandmanual.com/help/
Изменено: Firniara - 09.04.2019 13:20:57
массовое переименование стилей в проектах
 
Если название стиля поменять во всех проектах на новое (одинаковое для всех), то форматирование не пропадет, просто заменится на новое. Надо только проверить везде ли заменено название (иначе проект будет считать стиль "удаленным" и форматирование собьется).

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

Если же необходимо просто опубликовать проект с другим стилем, то для шаблонов (PDF, HTML и т.д.) не нужно менять название стилей, можно просто поменять настройки шаблонов.
Аннотация (абстракт), Контент после названия и до оглавления
 
в PDF шаблонах есть 3 вкладки после Cover: Title 1, Title 2, Title 3 - сюда можно закидывать что угодно. Необходимо только открыть  их в шаблоне PDF (галочка Print this section in manual)

в HTML сложнее, мы в итоге сделали отдельную HTML страничку со ссылкой на опубликованную веб-справку.
Грамматика (Сложносочиненное предложение) в техническом тексте, Пунктуация в сложносочиненном союхном предложении
 
Плюсую. Следует избегать сложных предложений и по возможности разбить на два. Либо, если это процедура, вывести списком шагов
Работа с множеством проектов
 
  1. Создать кучу разных шаблонов в css
  2. В публикации надо создать несколько задач и для каждой задачи указать свой шаблон для экспорта.
  3. Можно воспользоваться репозиториями, но мы допустим их используем если надо поменять шрифты внутри проекта, т.к. шрифты в CSS применяются только к заголовкам
ссылка на пункт
 
Существует глобальная переменная для ссылок <%TARGETTITLE%>. Делается просто, делаешь ссылку на нужный раздел, а в названии ссылки прописываешь эту переменную. При экспорте в она автоматом подстроится под нужный текст. Для этого нужно только настроить экспорт.
Изменено: Firniara - 09.04.2019 13:29:55
Путь к папке с картинками по значению переменной, Как менять папку с картинками
 
Какие-то сложные махинации, просто делаешь вторую папку и добавляешь ее в путь проекта, кладешь туда новые картинки.
В проекте вставляешь картинки рядом с другими картинками и прописываешь условия для нужного тебе экспорта, например:

<IF USER_GUIDE> Picture 1<END><IF USER_GUIDE_2>Picture 2<END>
Или
<IF USER_GUIDE> Picture 1<ELSE>Picture 2<END>

Следовательно при publish в задаче указываешь нужный Include options галочками, например:

1. Output file: User_Guide; Include options: %USER_GUIDE%
2. Output file: User_Guide_2; Include options: %USER_GUIDE_2%

И в каждый экспорт уйдет нужная картинка. Ну это мой вариант, если есть другие, то я о них не знаю.
Изменено: Firniara - 23.07.2018 14:04:18
Сомневаюсь в значимости должности техписа в конкретной компании - как быть?
 
Рекомендую ознакомиться с данным видео (про техписов) https://www.youtube.com/watch?v=osY0bZ3wxHY - тут весьма интересно сказано про то как не дооценивают технических писателей, может появятся новые идеи.

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

И, как правило, если у нас нет задач, то мы всегда найдем что поделать - т.е. сами создаем себе задачи и активно работаем с разработчиками, аналитиками и прочими (консультация, перевод текстов и т.д.).
Работа с множеством проектов
 
Репозиторий стилей можно создать, только надо чтоб базовые стили во всех проектах были одинаковые. Потом в самом репозитории можно добавлять любые стили и просто подключать к проектам. Удобно.  
Переменные для подписи картинок
 
О спасибо большое! до меня бы еще долго доходило как правильнее.
Переменные для подписи картинок
 
Кто-то может подсказать, как сделать нумерацию картинок в H&M не "1","2","3", а к примеру "1.3-2" через переменные?

<%HMFIGURECOUNTER%>.<%HMFIGURECOUNTER+2%>-<%HMFIGURECOUNTER+1%> - это вообще верно?
Изменено: Firniara - 07.02.2017 17:02:29
Страницы: 1

Рейтинг@Mail.ru