Size: a a a

Технические писатели

2021 September 01

МО

Михаил Осокин... in Технические писатели
"нужны правки со стороны" - это, пожалуй, самое главное, что не позволяет отказаться от Word
источник

АД

Анастасия Дахина... in Технические писатели
+
источник

АД

Анастасия Дахина... in Технические писатели
ну к этому у меня еще пара нюансов:
- Я пишу по ГОСТу и возникают проблемы с вставкой рамок. Другими средствами пока не знаю как это сделать.
- Форматирование таблиц. Тоже квест.
- Автоматическая нумерация изображений и таблиц. Пока в средствах автоматизации не встречала такой функции.
Для меня это самые большие проблемы, чтобы остаться на ворде😞
источник

АД

Анастасия Дахина... in Технические писатели
Спасибо
источник

K

K in Технические писатели
Думаю, это все можно делать в LaTeX. Немного сложнее форматировать (нужно знать команды, имеются свои тонкости), но все работает стабильно и железобетонно в отличие от ворд. Для ревью в моей организации либо используют Overleaf.com Латек сервер для тех кто не боится Латек, либо копируют контент в ворд-подобный файл, там получают правки, а потом их вносят в Латек.
источник

정제니 in Технические писатели
нумерация и таблиц и рисунков автоматика, все работает ок даже на 400 стр
источник

АД

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

АД

Анастасия Дахина... in Технические писатели
хотя вообще смотря в чем. при конверте в пандок есть, а там где формирование из единого источника типа диты - нет
источник

АД

Анастасия Дахина... in Технические писатели
а если их будет несколько типов, например для приложения к документу идет отдельная нумерация, то...да даже не представляю реально ли это
источник

D

Dmitriy in Технические писатели
dita-ot генерит сквозную нумерацию и для страниц, и для изображений, и для таблиц. по умолчанию без префикса номера раздела
источник

АД

Анастасия Дахина... in Технические писатели
это отличная новость, а то я даже расстроилась, пока ее смотрела.
источник

D

Dmitriy in Технические писатели
dita это xml-схема, которая не имеет отношения к оформлению. нужно смотреть детали реализации конверсии в нужный формат
источник

АД

Анастасия Дахина... in Технические писатели
такой вопрос, а вот это оформление где вообще менять? Это отдельная прога или файл какой-то? Или это средство конвертации типа пандока нужно и в нем уже шаблон?
источник

ET

Eduard Tibet in Технические писатели
Каждый инструмент имеет свой набор файлов для настроек. Для xml-based markups (docbook, dita) - основной инструмент xslt. Для lml - соответствующие тулы для форматов (rst, adoc, md и другие).
источник

АД

Анастасия Дахина... in Технические писатели
то есть это зависит от исходной разметки?
источник

ET

Eduard Tibet in Технические писатели
В документации существует два понятия инструментальной части (мы сейчас не берем контентную часть): формат и инструменты, которые этот формат обрабатывают. Часто один формат может обрабатываться разными инструментами. Причем, речь идет об инструментах двух типов: инструменты создания (authoring tool) и таковые для хранения/обработки/паблишинга.
источник

ET

Eduard Tibet in Технические писатели
Как пример: есть docbook (1). Это всего лишь набор xml-тегов для представления семантического контента. Для него существуют редакторы (например, XMLMind, OxygenXML), даже vim подойдет (2), если ничего нет под рукой :) Далее этот формат необходимо где-то хранить (для этого существует SCM: git, svn, hg и другие), обрабатывать c помощью определенного языка (по умолчанию xslt) и публиковать (3) (docbook xsl - набор xslt предназначенных для получения выходных форматов). Самое интересное, что наличия п.1, совсем не означает необходимость использования конкретного п.2 и конкретного п.3, хотя по дефолту все берут, то что есть. Но, например, в свое время BBC (по-моему или кто-то из gov.uk) сделало свои xslt для обработки (1). Такая практика, конечно, применима в основном к открытым стандартам.
источник

ET

Eduard Tibet in Технические писатели
Один из примеров того, что все следуют по дефолтному пути и даже не знают, что происходит вовне - лично встречал на различных митапах. Возьмем DITA (1). Практически все используют Oxygen XML (2), хотя существует XMlMind, а для обработки - dita-ot (3), хотя существует тот же ditac.
источник

ET

Eduard Tibet in Технические писатели
Анастасия Но вам надо идти не по пути инструментов, а по пути требований. Допустим, вам надо иметь средство редактирования (2),  которое могут использовать другие. В этом случае FrameMaker - не подойдет, ибо тогда придется покупать его для тех, кто будет редактировать. С другой стороны, есть проект Foliant по приспособлению markdown к использованию в ГОСТ среде. Он не требует покупки чего-либо, но редакторы должны уметь работать с маркдауном.
источник

АД

Анастасия Дахина... in Технические писатели
Спасибо за развернутый ответ)
источник