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

Всем привет!

[QUOTE]zukatoka пишет:
Спасибо вам всем большое, начиталась ваших советов, перерыла форумы, решаюсь на MadCap Flare, т.к. понимаю, что моментальный переход на технологию DITA будет немного сложным, все-таки, если правильно понимаю, MadCap Flare это какой-то переходный продукт и мне будет в нем проще, хотя бы благодаря понятному интерфейсу. Возникли только три важных вопроса:
1) Есть ли у данного продукта русскоязычная поддержка? Куда можно обращаться, если зайду в тупик?
2) Позволяет ли данная программа делать ссылки на разные топики внутри одного документа? Допустим, могу ли я внутри выходного документа word настроить перекрестные ссылки? А есть ли возможность однократной настройки перекрестных ссылок в едином источнике и затем использования их в разных выходных форматах?
3) Я так понимаю, интерфейс программы на английском языке, а возможно ли её русифицировать? Может быть отдельно можно где-то купить (скачать) русификатор?
[/QUOTE]Думаю, будет правильно вот сюда обратиться и всё уточнить :)

[QUOTE]ADVANCED пишет:
Внутри процесса генерации как бы выстраивается полная карта документа из всех задействованных файлов, включая ссылки на внешние документы. Выполняется разбивка на книги, документы, разные структуры и т.п., отбрасывая (фильтрами) ненужные файлы, выполняется нумерация всех разделов, таблиц, рисунков, приложений, примечаний и всего что можно/нужно нумеровать. А потом применяются стили к каждой единице документа (сайт это или отдельный PDF или CHM или электронные книги без разницы). В стилях можно выводить номера, можно их отображать своими шрифтами и делать что угодно, обрезать, сокращать и т.д.
[/QUOTE]CSS позволяет создавать генерируемое содержимое и автоматически нумеровать главы, рисунки, списки с помощью CSS-счётчиков внутри глав, книг, разделов. Для этого просто нужно корректно настроить таблицу стилей.

Пусть обязывают :)) Моя специальность не противоречит занимаемой должности.

[QUOTE]zukatoka пишет:
Для того, чтобы параллельно можно было генерить разные форматы приходится настраивать вручную подпись к каждому рисунку, причем как настроить автоматическое обновление нумерации по всему документу в процессе именно разработки, вообще тайна из тайн.
[/QUOTE]Автоматическая нумерация рисунков - проблема и для HTML-справок, в чём бы они ни разрабатывались. У меня пока что для этого есть только одно решение - CSS-счётчики.

У меня отпуск нескоро, поэтому посмотрю, что дальше будет, а там уж решу

[QUOTE]Elanor пишет:
techwriter , присоединяюсь.
Как начался "крысис" 2008го года, всегда что-нибудь такое случалось.[/QUOTE]Я надеюсь, что выживу :)) Мне проект был обещан после НГ на полтора месяца. Надеюсь, что всё сложится :)

[QUOTE]writer пишет:
В 2015 году из-за спада в экономике работодатели могут отказаться от традиционной индексации заработных плат. Повышения будут «точечными» – только тем сотрудникам, которых работодатель захочет удержать во что бы то ни стало

о том, что все будет плохо написано [url=http://top.rbc.ru/economics/01/12/2014/54786d20cbb20f5ec0136bd1?utm_source=newsmail&utm_medium=news&utm_campaign=news_mail2]здесь[/url]
[/QUOTE]Мне кажется, всегда так и было :)

Кстати [url=http://techwriters.ru/forum/forum598/topic19777/]тут[/url] было что-то аналогичное :)

[QUOTE]s.chaschin пишет:
Подскажите, как правильно назвать такое выделение текста?
[/QUOTE]Начертание.

[QUOTE]Ден пишет:
вообще она (сущность) это, собственно, название настройки. К ней привязывается одна настройка, с помощью, которой она выбирается, а во второй настройке, что она будет делать. Вообщем, такое триединство  :D  ..
[/QUOTE]Может, тогда так и оставить "сущностью"? Как второй вариант, можно назвать "объектом" :)

[QUOTE]Ден пишет:
Есть у нас в системе сущность, которая связывает две различные настройки. Не понимаю как ее можно назвать, термин "сущность" в документации пользователя использовать не хочу.
[/QUOTE]Смотря какие настройки и каким образом связывает.

[QUOTE]Гость пишет:
Здравствуйте, готовим комплект документов на систему. Имею ли я право ссылаться в одних документах на другие, чтобы не повторять одну и ту же информацию несколько раз). Если да, то на основании какого ГОСТа или иного нормативного документа я могу так поступить?
[/QUOTE]Уточните, пожалуйста, какой комплект документов Вы разрабатываете? Какой инструмент используете для написания документации? По каким стандартам? Попробуем подсказать, можно ли вставить ссылки, а если нет, то как организовать "единый источник".

[QUOTE]fs444 пишет:
Знаю, что можно подключить один tex-файл в другой, лежащий в той же папке. Но как выйти на уровень вверх?
[/QUOTE]Необходимо указать относительный путь к файлам. См. пример:
1. Путь к файлам:


2. Содержимое файла doc3:



3. Если поменяю для doc2 название папки:

[QUOTE]arm пишет:

Если проще, то у меня есть рукописный файл помощи (1), в который я хочу автоматически встроить другой CHM (2), сгенерированный Sandcastle help file builder-ом. Я могу генерить html для второго CHM, но как мне встроить эти страницы в проект (1) так, чтобы при изменении (добавлении/удалении) новых страниц в (2) они автоматически попадали в TOC файла (1)?
Цель в том, чтобы генеря при каждом билде файл(ы) (2) он автоматически встраивался в результирующий файл (1) под определенной нодой в дереве TOCа.
Честно говоря удивлен, что этот довольно простой сценарий не поддерживается системами генерации справок. Тем более, что CHM это всего лишь ZIP с определенным форматом.
[/QUOTE]

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

[QUOTE]arm пишет:
Ищу среду создания файлов помощи в разных форматах с такими требованиеми: есть (1) CHM справка для разработчиков, генерится отдельной тулзой, (2) глобальный проект помощи, который содержит различные кастомные (вручную написанные) разделы помощи. Файл (1) должен быть включен/вложен/импортирован под определенной мной нодой в TOC помощи. Т.е. при генерации помощи из проекта (2) в нужный формат (на сейчас нужны CHM и HTML для онлайн помощи) файл (1) должен также попасть в сгенерированную помощь.
Т.к. файл (1) в CHM формате, DrExplain должен распаковать его на HTML файлы и вложить в результирующую сгенерированную справку.
Файл (1) будет строится при каждой сборке проекта, поэтому импортнуть его содержимое в отдельный проект (если DrExplain это позволяет) без авто-обновления содержимого - не вариант.

Вопрос: DrExplain позволяет это сделать?
[/QUOTE]Я думаю, что CHM все равно генерируется из HTML и должны быть HTML-исходники? Поэтому вряд ли должны возникнуть проблемы с импортом. Вот, другой вопрос я не очень поняла. Т.е., у вас есть TOC, который хочется тоже "встроить" в проект?

Спасибо большое!

[QUOTE]writer пишет:
Ого, год издания 1908?? А так думаешь что в это время темные люди жили)
[/QUOTE]Да, 1908 год :)) Я случайно наткнулась на эту книгу, когда писала об истории технического писателя для своего блога :)))
Решила прочитать. В целом, мысли многие очень правильные. Правда, язык отличается от современного английского, что может вызвать трудности при чтении.

[QUOTE]''ivs0'' пишет:
А вы хотите что-то "свое" в ГОСТы написать? :-)
Или Вы предпочитаете взять оригинальные тексты 50-ти документов ГОСТ, свести их по перекрестным ссылкам, проверить их актуальность и скачать новые тексты, все это прочитать, запомнить и с легкостью всем этим пользоваться?
Ну, каждый сам решает.
[/QUOTE]Просто смысла в таких книгах не вижу. Это мое личное мнение.

[QUOTE]''ivs0'' пишет:
Посмотрите вот эту книгу, особенно если работаете на госструктуры. Уже 4 редакция в продаже.
[url]http://teh-doc.narod.ru/p_ogl_1.html[/url]
[/QUOTE]Напоминает рерайт стандартов, если честно.

Думаю, с этого надо начать  :)  ))
[url]https://archive.org/details/aguidetotechnic00gaylgoog[/url]
Я читала, очень интересно.
Очень хорошая книга для начинающих технических писателей:
Van Laan K. "The Insider's Guide to Technical Writing".
Русские книжки читала. Не очень впечатляют, конечно.

[QUOTE]fs444 пишет:
Нужно настроить конвертацию latex в html. Нашел в интернете кое-какую информацию, но все на английском и я пока не понял, заработает ли) Кто какими инструментами пользуется для этого?
[/QUOTE]Попробуйте конвертер.
Например, в TeXStudio есть встроенный конвертер в HTML.

С добрым утром!

[QUOTE]writer пишет:
нет, тут скорее всего имеется ввиду специфика удаленной работы. Не каждый сможет так работать, кого-то нужно пинать и следить за тем чтобы он работал, а на удаленной работе такого нет. Это как школа и институт, в школу нужно обязательно ходить на все уроки, в институте можно пропускать лекции, но главное чтобы сдать экзамены  :)  
[/QUOTE]Это точно. Человек должен уметь себя организовать и вовремя выдать хорошего качества работу. Да и тема непростая. Надо самостоятельно понять, как работает устройство. Для этого нужно иметь, как минимум, высшее техническое образование, хорошо знать физику, схемотехнику, автоматизацию технологических процессов в этой области. Мое мнение, для достижения хорошего результата (=получения качественной документации) лучше взять двух специалистов: технического специалиста и технического писателя. Иначе велика вероятность, что один человек с этим не справится.

Зависит от стиля изложения.
Я для себя установила следующее правило. Если форма содержит не более 3 полей, то описываю заполнение полей последовательно в тексте инструкции по первому варианту. При этом для каждого поля выделяю отдельный пункт инструкции. Если полей больше 3, то пишу фразу: "В форме "<Название формы>" заполните поля:". Ниже привожу таблицу с описанием полей по второму варианту.