Форум русскоязычного сообщества Ubuntu


Считаете, что Ubuntu недостаточно дружелюбна к новичкам?
Помогите создать новое Руководство для новичков!

Автор Тема: Профессиональные программы для технических писателей  (Прочитано 1169 раз)

0 Пользователей и 1 Гость просматривают эту тему.

Оффлайн Dzhoser

  • Автор темы
  • Старожил
  • *
  • Сообщений: 2425
    • Просмотр профиля
Приветствую вас форумчане! Есть ли среди Вас профессиональные технические писатели? Хотелось бы узнать, кто какими инструментами пользуется для создания документации в Ubuntu. Спасибо.

Оффлайн drion

  • Активист
  • *
  • Сообщений: 838
    • Просмотр профиля
Это должны быть какие-то особые текстовые редакторы?
Сейчас перевожу руководство одной инженерно-технической программы на русский язык.
Либры и гугл-переводчика вполне хватает.

Оффлайн Dzhoser

  • Автор темы
  • Старожил
  • *
  • Сообщений: 2425
    • Просмотр профиля
Это должны быть какие-то особые текстовые редакторы?
Это не только текстовые редакторы. Libre office хорошая программа, но вы пишите только один документ, а когда их много и нужно внести изменения сразу в нескольких документов и сохранить форматирование начинаются проблемы...

Оффлайн KJOI

  • Участник
  • *
  • Сообщений: 242
  • ALT Linux
    • Просмотр профиля
профессиональные технические писатели
Можно подробнее хто это?
Русский Линукс: https://www.basealt.ru/products/simplylinux/
Мой проект git «Kernel Manager» linux: https://github.com/Koi-foo/kernel-manager/

Оффлайн Dzhoser

  • Автор темы
  • Старожил
  • *
  • Сообщений: 2425
    • Просмотр профиля

Оффлайн KJOI

  • Участник
  • *
  • Сообщений: 242
  • ALT Linux
    • Просмотр профиля
Ну так ведь там же и написано какие инструменты нужны:
Цитировать
Основные инструменты технического писателя — текстовый редактор, диктофон, а также, в зависимости от особенностей проекта, руководства MS Manual of Style, Apple Style Manual, Chicago Manual of Style, программы MS Word, Adobe FrameMaker (для создания оффлайн-материалов), Adobe RoboHelp, MadCapFalre (для онлайн-документации) и другие.
Проще говоря для текста и расчетов офис, для изображений гимп и инкейс ну и видео+аудио по вкусу.
Libre office хорошая программа, но вы пишите только один документ, а когда их много и нужно внести изменения сразу в нескольких документов и сохранить форматирование
Есть такая штука вкладки и панели, а для изменения например 10 страниц или разных документов используется поиск и замена по открытым документам или файлам. Нарушит это форматирование или нет, завит как вы построили регулярное выражение.
Русский Линукс: https://www.basealt.ru/products/simplylinux/
Мой проект git «Kernel Manager» linux: https://github.com/Koi-foo/kernel-manager/

Оффлайн Dzhoser

  • Автор темы
  • Старожил
  • *
  • Сообщений: 2425
    • Просмотр профиля
KJOI, вы капитан очевидность. Я задал вопрос про программам в Ubuntu.
для создания документации в Ubuntu


Пользователь добавил сообщение 25 Январь 2021, 16:54:49:
Есть такая штука вкладки и панели, а для изменения например 10 страниц или разных документов используется поиск и замена по открытым документам или файлам
Это неудобно нужно открыть каждый документ,искать в каждом документе. Процесс трудоемкий.
« Последнее редактирование: 25 Январь 2021, 16:54:49 от Dzhoser »

Оффлайн KJOI

  • Участник
  • *
  • Сообщений: 242
  • ALT Linux
    • Просмотр профиля
Я задал вопрос про программам в Ubuntu
Внимательно читаем.
Цитировать
для текста и расчетов офис, для изображений гимп и инкейс ну и видео+аудио по вкусу.
Это неудобно нужно открыть каждый документ,искать в каждом документе. Процесс трудоемкий.
Еще более внимательно изучаем документацию к libreoffice, на темы:
Составной документ
Поиск и замена в открытых документах


Кстати возможно в других офисных программах это реализовано лучше можно глянуть ОО например или что-то еще вдруг понравится.

Однако я cоглашусь с тем что освоить офис если это не требуется достаточно сложно.
В качестве простого варианта можно пользоваться какой-то программой ide, например kate, geany, atom  и т.д.

Вот чтоб на пальцах в картинках.


« Последнее редактирование: 25 Январь 2021, 18:51:20 от KJOI »
Русский Линукс: https://www.basealt.ru/products/simplylinux/
Мой проект git «Kernel Manager» linux: https://github.com/Koi-foo/kernel-manager/

Оффлайн Дед Дима

  • Новичок
  • *
  • Сообщений: 46
    • Просмотр профиля
и тема странная и вопрос.
1. технический писатель - матюкнуться хочется, НО нельзя.
2. Инструменты. Вот, на пример, у переводчиков (заметьте - не технических писателей!) манов в Ubuntu, есть свой инструмент переводчика, но Вы его не получите и не начнете им пользоваться, пока не вступите в сообщество переводчиков. Что бы вступить, нужно КОРРЕКТНО дать переводы на ФРАЗЫ, АБЗАЦЫ... в общем поучаствовать. Примерно раз 100. И только после этого, если Ваши кусочки переводов удовлетворительные - велком, общение начнется, +инструмент, +формат...

И это везде. Есть среда обитания, в которой все устаканено, заходи, когда пустят и там все дадут, только пользу приноси...
И да,  Ваш пример ПОДРОБНЕЕ - лох-развод какой-то: знание ГОСТ, ОСТ, ТУ, ТО, ТП, СТП... в том числе и международных - это нечто!!! знать это НЕВОЗМОЖНО. Это миллионы документов.

сорян, если расстроил.
« Последнее редактирование: 25 Январь 2021, 21:29:02 от Дед Дима »

Оффлайн Dzhoser

  • Автор темы
  • Старожил
  • *
  • Сообщений: 2425
    • Просмотр профиля
Дед Дима,
лох-развод какой-то: знание ГОСТ, ОСТ, ТУ, ТО, ТП, СТП... в том числе и международных - это нечто!!! знать это НЕВОЗМОЖНО
Ну тут имеется в виду не заучивания как стишка, а знания что в каком ГОСТ посмотреть и каким руководствоваться. Поэтому все реально.И основных доков там не много меньше 100.
KJOI, пример хороший, но:
1. У меня есть например 4 документа в каждом из трех есть раздел "2. Технические требования", который включает подразделы "2.1 Требования к аппаратному обеспечению" и 2.2 Требования к программному обеспечению" и заменимость там нужно не одно слово а целый раздел, то есть его как минимум нужно набрать.
2. В этих 3 документах могут быть написаны разные требования, что усложняет корреляцию поиска.
3. В третьем документе не были заполнены разделы.
« Последнее редактирование: 26 Январь 2021, 07:04:07 от Dzhoser »

Оффлайн KJOI

  • Участник
  • *
  • Сообщений: 242
  • ALT Linux
    • Просмотр профиля
и заменимость там нужно не одно слово а целый раздел, то есть его как минимум нужно набрать
С одной строкой это просто пример, выше я уже писал о регулярных выражениях ide с ними работают. Вы можете сделать поиск блока или параграфа и его замены на то что нужно.

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

Вот на примере Пушкина и Лермонтова,да простят меня за это оба.



Вы выделяете нужный блок и тыркаете в нужную сторону стрелочку, блоки синхронизируются.
Русский Линукс: https://www.basealt.ru/products/simplylinux/
Мой проект git «Kernel Manager» linux: https://github.com/Koi-foo/kernel-manager/

Оффлайн Dzhoser

  • Автор темы
  • Старожил
  • *
  • Сообщений: 2425
    • Просмотр профиля
KJOI, то что вы предлагаете я знаю. С diff знаком, но это немного не то. В технической документации очень много разделов которые повторяются. Можете погуглить Единый источник документации (ЕИД). То есть в этих программах пишутся разделы документации, а потом ты просто их выбираешь и на основании выбора генерируются новые документы с правками.

Оффлайн KJOI

  • Участник
  • *
  • Сообщений: 242
  • ALT Linux
    • Просмотр профиля
В технической документации очень много разделов которые повторяются.
Нонсенс.
Слава богу я не читал ни одного такого ПИСАТЕЛЯ технического.

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

Проще говоря изучайте офис, его возможности и сопутствующее прикладное ПО.
« Последнее редактирование: 26 Январь 2021, 15:10:00 от KJOI »
Русский Линукс: https://www.basealt.ru/products/simplylinux/
Мой проект git «Kernel Manager» linux: https://github.com/Koi-foo/kernel-manager/

 

Страница сгенерирована за 0.075 секунд. Запросов: 25.