Разработка технической документации и технические писатели Технические писатели и разработка технической документации технические писатели в Телеграм 

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Выбрать дату в календареВыбрать дату в календаре

Страницы: 1
каким редактором это сделано?
 
Нашла в интернете пару скриншотов, на которых показано, что по клику на кнопку открывается дополнительное окно с настройками. Очень мне понравился такой способ, но не могу понять, каким графическим редактором такое можно сделать? И хорошо бы, чтобы это делалось быстро, парой кликов ) Накидайте идей, пжл!
скриншоты, показывающие последовательность шагов
 
Коллеги, поделитесь, пжл, хорошими примерами скриншотов, иллюстрирующих последовательность выполняемых шагов.

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

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

Как красиво и понятно показать такие переходы и вот эти взаимные зависимости? С минимумом слов, чтобы пользователь с одного взгляда понял что нужно делать, а не вчитывался в "нажмите... перейдите... если...".
Хотелось бы посмотреть на иллюстрации с чем-то похожим по смыслу. Но не для мобильных приложений (там экраны маленькие, можно хоть 3-4 в ряд разместить).  
powerpoint, колонтитул закрыт для изменений
 
Есть корпоративный шаблон для презентаций, разработан в незапамятные времена, создатели уже не с нами. В этом шаблоне в образцах настроен колонтитул с контактными данными, эти данные надо изменить. Колонтитул каким-то образом закрыт для редактирования. Флажок "Нижние колонтитулы" снять нельзя. Если включить флажок "Скрыть фоновые рисунки", то колонтитул не отображается. Отредактировать этот фоновый рисунок в колонтитуле не получается. Подскажите, пжл, где копать?
дизайн для тех. писателей
 
Вопросы к тем, кто слегка выходит за рамки написания чисто технической документации и сталкивается с необходимостью делать более-менее красивые иллюстрации к документам:

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

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

Буду признательна за ссылки и идеи )
условные пользовательские переменные
 
В проекте есть набор билдов, причем этот набор постоянно меняется - под конкретного заказчика создается набор тем, которые в этот билд включаются. Соответственно, имя билда совпадает с именем заказчика.

Есть пользовательская переменная, которая должна принимать определенное значение в зависимости от билда. Например, пусть эта переменная формирует подпись под изображением, не суть важно. Один заказчик хочет видеть подпись в формате "Рис.1", второй "Изображение 1", третий вообще не хочет номеров, или еще как-то. Переменная используется в очень многих топиках. Проблема в том, чтобы значение этой переменной настраивалось где-то один раз в зависимости от билда. Потому что при появлении очередного билда с особыми требованиями невозможно пройтись по всем топикам и добавить новое условие вывода там, где эта переменная используется.

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

Можно ли это встроить в проект? Где-то написать сценарий или формулу для формирования значения переменной в зависимости от выбранного билда.
новые публикации
 
Было бы удобно видеть сводную ленту последних публикаций на форуме, из всех разделов. В обратном хронологическом порядке (последние публикации - первыми). А уж из ленты по ссылкам переходить в раздел и в ветку. А то заходишь на форум и теряешься ) Приходится даты последних сообщений проверять во всех разделах.
Перекрестные ссылки - Word или что-то другое?, Поддержка актуальности перекрестных ссылок в документе.
 
Описываю варианты использования в виде:
Основной сценарий:
  Шаг 1. ...
  Шаг 2. ...
  Шаг 3. ...
Альтернативный сценарий к шагу 2
  ...
Альтернативный сценарий к шагу 3
  ...
  возврат к шагу 2 основного сценария


Ну и так далее. Потом оказывается, что в основном сценарии нужно внести дополнительный шаг между 1ым и 2ым. То есть альтернативные сценарии должны называться "к шагу 3" (вместо к шагу 2) и "к шагу 4" (вместо к шагу 3), и возврат должен быть к шагу 3 (а не к шагу 2). Вручную переименовываю. Потом вносятся еще изменения, снова переправляю. Сценарии длинные, альтернатив много, ссылки на шаги разбросаны по всему документу. Вручную все время переправляю номера по всему документу, опасаюсь что могу где-то пропустить, а для альтернативного сценария критически важно понимать, к какому шагу основного сценария он относится и куда потом идет возврат.  

Есть ли какое-то средство или способ для автоматической поддержки актуальности подобных ссылок?
Изменено: revo - 15.04.2016 06:44:10
английский для техписа
 
Имеется английский язык на уровне чтения технических текстов, понимания презентаций "на слух" и редактирования готовых переводов "англ -> рус". Надо довести его до уровня написания технической документации на английском (то есть перевода "рус -> англ"). Что посоветуете для обучения? Какие учебники, курсы (если очные курсы, то в Москве) и т.п.
Изменено: revo - 23.04.2015 17:49:37
все внешние ссылки проекта, Как получить список всех внешних ссылок проекта
 
В большом проекте много ссылок на внешние источники. Часть этих источников переехали по другому адресу. Надо выловить их по всему проекту, чтобы изменить. Придется просматривать каждую тему, или можно как-то получить список всех внешних ссылок в проекте?

И на будущее - такие вещи имеет смысл делать с помощью переменных? Если да, то как конкретно?
Иконки в оглавлении
 
1. В компании традиционно для веб-хелпа используется свой набор иконок в оглавлении (тема, раздел открытый, раздел закрытый). Иконки прописаны в скине. Публикую проект. Смотрю локально - есть иконки. Выкладываю на сервер (всю папку копирую целиком), смотрю оттуда - не видны наши иконки, видны типовые, по умолчанию. Видимо, что-то недовыложилось. В чем может быть дело и как поправить?

2. Тот же проект. Есть две копии - локальная и на сети. Если публикую из локальной копии - беда с иконками (см выше). Если публикую из сетевой - все ОК. Скин один и тот же. Чего и где не хватает на моем компе?
Навигация в WebHelp
 
Когда я публикую веб-хелп, слева у меня раздел с содержанием (TOC), а справа сами темы. Если я открываю тему в новой вкладке или в новом окне, то раздел TOC не показывается. Это очень неудобно. Как я поняла, за это должен отвечать параметр "When a topic is loaded outside the navigation frame, force it to reload the navigation frame" в настройке навигации (Configuration -> Publishing Options -> WebHelp -> Navigation). Он включен. Но не работает :( В чем причина может быть?
рисунки при экспорте в Word, рисунки сохраняются как ссылки, а надо - как изображения
 
Как сохранить рисунки в самом файле, а не ссылками на внешние изображения?

Делаю экспорт из H&M в RTF, картинки вставляются как ссылки. Если потом RTF сохраняю как MHT, то там рисунки есть, файл нормального размера. Если потом этот MHT сохраняю как DOCX, то рисунки опять заменяются на ссылки, файл весит очень мало.

PDF не предлагать :)
Кавычки елочкой, Как поставить кавычки елочкой
 
Искала в свое время возможность ставить в H&M «русские» кавычки елочкой, не выбирая их каждый раз из общего списка спец. символов (долго) и не набирая на alt-наборе (у меня ноут и нет цифровой клавиатуры) . Наконец, нашла и хочу поделиться с сообществом. Проверяла - работает (но только с правым alt) .
http://softlakecity.ru/advice/kavyichki-yolochki-na-russkoy-klaviature-takie-kak-v-word-a-takzhe-nemetskie-lapki-angliyskie-odinarnyie-i-dvoynyie
Страницы: 1