Программное обеспечение для технического письма

Я заинтересован в более новом программном обеспечении/стеке программного обеспечения для использования в написании технических документов. В течение долгого времени я использовал LaTeX, чтобы справиться с этим, но для публикации более длинных материалов, таких как книги, используется другое программное обеспечение. Пока что больше всего выделяется DocBook.

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

Редактировать: я в основном работаю на Mac. Хотя использование программного обеспечения в виртуальной машине не исключено, если нет альтернативы, это не будет моим первым выбором.

Редактировать: элементы указаны...

я собираюсь начать книгу, и я склоняюсь к LaTeX
Если вы уже знакомы с LaTeX, придерживайтесь его. Единственным худшим недостатком LaTeX является крутая кривая обучения. Как только вы это сделаете, в ваших руках будет инструмент, которому другие могут позавидовать.

Ответы (10)

Ответ во многом зависит от того, что вас окружает и каковы ваши потребности; при условии, что

  • У вас нет больших потребностей, кроме наборов символов Latin-1 и Math, или простого использования наборов символов Unicode.
  • У вас нет потребности в чрезмерно богатых или сложных макетах страниц (т.е. вы не делаете макеты страниц, которые вы видели бы в глянцевом журнале).
  • У вас нет требований к внешнему формату/структуре, которые могут конфликтовать
  • Ваша основная операционная среда — Windows

Затем Adobe FrameMaker, вероятно, является лучшим выбором для длинных технических документов.

Adobe за последние несколько лет урезала все предыдущие поддерживаемые платформы для Frame (68K/PPC MacOS, краткое заигрывание с Linux, различные Unices по одному) до такой степени, что не стоит рассматривать, если вы не на Окна. (И, к сожалению, с исторической точки зрения, я думал, что ветвь Frame, которую они разработали для Windows, была далеко не такой надежной или простой в использовании, как ее версия для Mac или Unix, но теперь, когда они действительно только поддерживает одну платформу для него.)

Я никогда не пользовался никаким инструментом, который бы упростил работу писателя. Существуют лучшие инструменты для верстки страниц, лучшие инструменты только для написания задач, лучшие инструменты для крупномасштабного структурированного управления контентом, но если вы пытаетесь написать объемный технический документ с нуля и быть в состоянии создать достаточно готовый к полету PDF-файл, который вы можете передать издателю или типографии, тогда FrameMaker был и остается довольно несравненным.

DocBook — это скорее спецификация структуры документа, чем программный стек, поэтому для написания со структурой DocBook все равно потребуется какой-то набор инструментов. Я полагаю, что версия FrameMaker, поддерживающая структурированное редактирование, поддерживала использование структуры DocBook и позволяла создавать выходные данные SGML вместо или в дополнение к «печатным» выводам (например, PDF или PS). Однако использование структурированных функций Frame, по моему опыту, было довольно сложным и привередливым: если у вас нет четкого требования к полностью структурированному исходному коду или для передачи DocBook в вашу систему издателя, я бы поставил под сомнение необходимость этого на вашем месте.

Я думаю, что вся цепочка инструментов не должна быть легкой. Я согласен потратить немного времени на его создание, если это необходимо. Я думаю, что если я могу легко создавать структурированный контент, я всегда могу вернуться и преобразовать контент в другой формат с некоторой очисткой. PDF не является моим целевым выходом, как это было с LaTeX, поскольку издателям нужно будет сделать хотя бы некоторое редактирование копии для рассматриваемого окончательного формата. Любой «печатный» вывод будет только для меня. Спасибо за ответы, появилось больше вещей для размышлений.

Как сказал Виктор, FrameMaker, вероятно, является лучшим широко используемым инструментом для выполнения того, что вы пытаетесь сделать. Еще один инструмент (только для Windows), который я сейчас использую, это Madcap Flare , но он довольно дорогой.

Другие соображения:

DocBook — это спецификация, а не инструмент (как сказал Виктор). Это XML, поэтому вы можете использовать любой XML-редактор для написания контента. Возможности включают XML Notepad (бесплатно), XML Spy (раньше был бесплатным, а не сейчас?), Oxygen ($), Epic ($$). (Лично я просто использую Emacs, но мои коллеги считают меня странным. :-))

Чтобы перейти от DocBook XML к полезному выводу, вам потребуется некоторый шаг преобразования. Мы используем XSLTProc для создания HTML и XEP ($) для создания PDF. (Настоящая цепочка там XML -> ФО (объекты форматирования) -> PDF.) Мы накатывали для этого собственные скрипты сборки, используя таблицы стилей и другие ресурсы, скачанные с сайта DocBook, где могли. Сейчас может быть лучшая готовая поддержка (мы создали ее около семи лет назад), но, поскольку вы упомянули о желании развернуть свою собственную, я хотел бы отметить, что это выполнимо.

Спасибо за ваш вклад, Моника. Похоже, что Epic совершенно излишен в своем нынешнем состоянии. Некоторые старые версии появились, как будто они могут быть полезны. Кислород, с которым я тоже не был знаком, может быть вариантом. Я думаю, что пришло время выйти за рамки использования vim сейчас, будет много писать, и, возможно, более интегрированный опыт, наконец, будет стоить для меня.
@Travis, моей копии Epic около шести лет, поэтому я не в курсе новейших функций или раздувания. :-)

Я бы сказал, что новейшая и, на мой взгляд, наиболее многообещающая тенденция заключается в использовании облегченных языков разметки, в частности, Markdown , reStructuredText и ASCIIDoc .

Как коммерческие инструменты WYSIWYG, такие как FrameMaker , так и словари XML, такие как DocBook и DITA , требуют сложных и несколько громоздких редакторов и, как правило, загромождают процесс написания либо форматированием, либо структурным соответствием.

Облегченные языки, напротив, могут быть написаны в текстовом редакторе по вашему выбору с небольшими накладными расходами, а исходный формат очень удобочитаем, в отличие от XML. Все три имеют хорошо поддерживаемые цепочки инструментов.

У них нет возможностей для структурных ограничений, которые вы найдете в XML-приложении, но вы не указали на необходимость этого. Для простоты написания технической статьи с разумной поддержкой таких вещей, как математика, с использованием недорогих или бесплатных инструментов, я бы посмотрел либо на reStructuredText, либо на ASCIIDoc (Markdown более упрощен и больше ориентирован на простые веб-страницы).

Загляните в Ликс. Это интерфейс с графическим интерфейсом, который выводит файлы документов в различных форматах, особенно в латексе. Вы можете создать документ в формате DocBook, экспортировав его в формате SGML и затем преобразовав его.

См. http://wiki.lyx.org/LyX/DocBook .

Похоже, что поддержка DocBook довольно нарушена, судя по ссылке «В настоящее время ему требуется LyX 1.2.0, и он не будет работать с более поздними версиями LyX». Кроме того, он ссылается на ошибку, с которой связаны другие ошибки, связанные с этой поддержкой. Я не думаю, что это приведет к тому, что я хочу. Тем не менее, я буду следить за этим, может быть, это того стоит, если это будет очищено.
LyX позволит вам использовать LaTeX в гораздо лучшей среде. Я не уверен, что DocBook — это конец всего, что вы думаете. Тем не менее, у меня есть предложение, которое я поставлю в качестве ответа.
Я и сам не уверен, что DocBook — это конечная цель. Но при работе с издателями это наиболее предпочтительный формат для технических книг, на которые я ориентируюсь. Спасибо за ваши предложения.

Я использую ClickHelp для технического письма. Это инструмент документации на основе браузера, используемый для создания онлайн-руководств пользователя, баз знаний, файлов справки, часто задаваемых вопросов, учебных пособий и мгновенной публикации их на своем портале. В противном случае вы также можете экспортировать свое письмо в разные форматы.

Нет необходимости ничего устанавливать.

Этот инструмент документирования обладает всеми мощными функциями, которые могут вам понадобиться для крупных проектов:

  • Онлайн-помощь, защищенная паролем.
  • Простой импорт и экспорт. Поддерживаются самые популярные форматы, такие как HTML, CHM, PDF, DOCX, DOC, RTF, EPUB и т. д. Итак, если вы хотите перейти с другого инструмента, вы можете импортировать свои документы и все.
  • Мощный полнотекстовый поиск. ClickHelp имеет собственный запатентованный полнотекстовый поиск, который помогает вам и вашим читателям легко находить темы, он также поддерживает подстановочные знаки, а также, если вам нужно, можно исключить определенные темы из результатов полнотекстового поиска.
  • Составление отчетов. ClickHelp имеет внутреннюю аналитику, которая поможет вам измерить показатели производительности команды и проанализировать статистику поведения конечных пользователей.

Если вам интересно, вы можете просмотреть характеристики здесь .

Посмотрите Скривенера . Я считаю, что он может генерировать формат DocBook, хотя его истинная сила заключается в исследовании/создании документа, а не в редактировании формул.

Я рассматривал возможность использования Scrivener в моем последнем проекте. Моими результатами были файлы Word, поэтому первое, что я проверил, это то, как выглядел документ при переносе в Word. А ответ был в том, что стилей не было — все форматирование было низкоуровневым. Это может быть нормально, если вы пишете художественную литературу или журнальную статью. Но для технического письма это просто неприемлемо. Технический документ должен быть тщательно структурирован, чтобы его можно было поддерживать, а в Word стили являются важнейшим ресурсом структурирования.
Для поддержки DocBook см . Scriv2DocBook . Похоже, что-то, что было изобретено, чтобы любители Scrivener могли отправлять книги О'Рейли. Вы должны ввести все XML вручную ! Это нарушило условия сделки для меня.

Лучший текстовый редактор для текста с формулами, безусловно, TeXmacs .

Имеет хороший рендеринг и мощную систему макросов.

TeXmacs не является редактором LaTeX, но у него есть импорт и экспорт для формата LaTeX.

FrameMaker, хотя и является старым отраслевым стандартом, не поддерживает языки с написанием справа налево.

Madcap Flare уже много лет рекламируется на форуме TECHWR-L как альтернатива FrameMaker. Никогда не пользовался, поэтому оценить не могу.

Adobe InDesign лучше работает в том же пространстве, что и FrameMaker, но пока этого не произошло.

FrameMaker идеально подходит для книг. Действительный. Книги. Я бы не хотел выпускать технический проект длиной в книгу (даже если книгу можно будет увидеть только в цифровом виде) без него. Он имеет необходимую поддержку для запуска верхних и нижних колонтитулов, оглавлений, указателей, перекрестных ссылок, специальных символов, формул, пользовательских словарей, глав, условного текста и главных страниц.

Сейчас я использую HTML/CSS для всего остального. Для HTML доступны миллионы редакторов, в то время как CSS обеспечивает гибкость форматирования стилей, а теперь с помощью flexbox, grid и т. д. можно делать очень сложные макеты. Все виды программ могут импортировать и экспортировать HTML, поэтому вы не привязаны к какой-то одной программе. Вы можете быть настолько структурированными или неструктурированными, насколько захотите. Я использую бесплатный HTML-редактор WYSIWYG (MS Expressions Web) для создания интерактивной справки, руководств пользователя и внутрипрограммной документации.

А иногда вам просто нужно использовать Word, потому что он есть у всех, он мощный, и вы знаете, как им пользоваться. Но он может отстой (быть нестабильным) для длинных проектов, таких как книги объемом более 100 страниц.

Другой вариант — полагаться исключительно на XML, сверяться со схемой, преобразовывать в HTML, а затем применять разные листы CSS для разных результатов (т. е. для Интернета, печати, мобильных устройств и встроенной справки).

Хотя, несомненно, это правильный ответ, владение всем, что здесь задействовано, потребует много времени, которое я не хотел бы тратить. Вероятно, есть некоторые файлы XSLT и CSS, которые нужно украсть, чтобы пройти часть пути.
Вы можете использовать схемы DITA или Docbook или другое готовое решение. Что касается CSS, его довольно просто изучить, реклама сослужит вам хорошую службу для любого другого веб-контента, над которым вы можете работать (которого может быть много). В качестве альтернативы, веб-дизайнер или друг, разбирающийся в CSS, могут очень захотеть помочь.
Программное обеспечение для технического письма
СпросиСетьПолитика конфиденциальности1y, 0v