Заказать звонок

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

Форум » Пользователи » '''ADVANCED'''

Внимание! У нас сбои с почтовым сервером! Если не пришло письмо о регистрации или смене пароля напишите нам на info@techwriters.ru! 
@twriters
 obmen_soobsheniyami.pngчат для технических писателей в Telegram

 Зарегистрируйтесь
Выбрать дату в календареВыбрать дату в календаре

Страницы: Пред. 1 ... 62 63 64 65 66 67 68 69 70 71 72 След.
Общая информация
 
[size=150:1zl2yqbk]ИСХОДНЫЕ ФАЙЛЫ[/size:1zl2yqbk]

Исходными файлы документации, создаваемые техническими писателями могут быть:
*.ditamap - файл-карта;
*.dita - файл-топик;
*.xml - файл-топик;
*.ditaval - файл-фильтр.
Общая информация
 
[size=150:1c10w1ru]Многократное использование контента на уровне карты[/size:1c10w1ru]

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

Если ряд топиков встречаются в одной и тойже последовательности и в одной и тойже иерархии, они могут быть объединены в мини-карту. Мини-карта может использоваться как единое целое в других картах.

В разных картах мини-карта может находиться на разных уровнях иерархии и занимать любое место в последовательности топиков.

[size=150:1c10w1ru]Топик-ориентированный подход[/size:1c10w1ru]
* Документ представлен как организованная коллекция отдельных контекстно-независимых топиков
* Топик описывает один единственный предмет
* Каждый топик написан таким образом, который позволяет его использовать во множестве контекстов
* В топике может использоваться условный текст
* Все топики хранятся в отдельном месте
* Для публикации топики собираются вместе в карту документа. Карта определяет порядок и иерархию документа.
* В зависимости от типа информации, которую описывает топик, топик имеет определенную внутреннюю структуру.

[size=150:1c10w1ru]Типизация информации[/size:1c10w1ru]
* Concept - Для описания общей информации
* Task - Для пошагового описания процедур
* Reference - Для документирования команд и настроек
* Собственный - Для создания других возможностей

[size=150:1c10w1ru]Отделение контента от форматирования[/size:1c10w1ru]
* Топик содержит только контент
* Информация о форматировании элементов топика хранится в отдельных файлах - шаблонах форматирования
* Один и тот же контент может быть представлен множеством способов, путем наложения разных шаблонов
* Форматирование накладывается на контент во время создания контента, а также во время публикации
Общая информация
 
[size=150:25bj805t]Профилирование и фильтрация контента[/size:25bj805t]
[b:25bj805t]Профилирование контента[/b:25bj805t] - разметка различных вариаций одного и того же контента и определение в каких случаях каждая из вариаций должна применяться. Например, один и тот же контент может иметь различные вариации для разных клиентов или для разных версий продуктов.

Условный контент - различные вариации контента. При публикации остается одна или несколько вариаций, релевантных для данного случая. Все остальные вариации отфильтровываются.

Условный контент помечается с помощью атрибутов. Атрибуты могут быть определены у любого элемента. Основные атрибуты для профилирования контента:
* audience;
* platform;
* product.

Новые атрибуты могут быть добавлены через механизмы специализации. Фильтрация условного контента при публикации происходит с помощью фильтров, определяемых в формате *.ditaval. Файлы *.ditaval состоят из:

* Пар атрибут-значение.
* Действия (скрыть или показать) для каждой пары атрибут-значение (см пример):
[code:25bj805t]<?xml version="1.0" encoding="UTF-8"?>
<val>
<prop att="audience" val="p" action="exclude"/> Все элементы, в которых задан атрибут audience="p" будут исключены
<prop att="audience" val="a" action="include"/> Все элементы, с атрибутом audience="a", будут включены
</val>[/code:25bj805t]

Для получения различных выводов, в зависимости от того, какой контент должен быть отфильтрован, может поддерживаться несколько фильтров.
Общая информация
 
DiTA = Darwin Information Typing Architecture
XML стандарт для создания и публикации технической документации
Разработан IBM в начале 2000 для улучшения практик многократного использования контента. Развивается при поддержке OASIS и IBM.

[size=150:1q43wktr][b:1q43wktr]Достоинства формата D I T A[/b:1q43wktr][/size:1q43wktr]
Если требуется подготовить гипертекстовую документацию, которая оформляется в виде большого количества страниц умеренного размера, связанных ссылками друг на друга.
Если желательно организовать работу в режиме "снизу вверх". Т.е. сначала собрать "первичную информацию" в аморфном и "растерзанном" виде, а потом заняться её упорядочением, группировкой и т.п. При этом хорошее решение может быть найдено не сразу и желательно иметь возможность опробовать разные варианты упорядочения материала.
Если над документацией работает несколько человек, и желательно, чтобы они могли работать параллельно и "не толкая друг-друга локтями". Здесь опять-таки существенна возможность легко собирать конечный вариант документации из разрозненных частей.
Если желательно иметь возможность сгенерировать документацию в нескольких форматах: в виде гипертекстовых справочников (help-ов), в виде pdf-документов, в формате RTF, и т.п.

[size=150:1q43wktr]Недостатки формата DITA[/size:1q43wktr]
Формат DITA не содержит средств для записи сложных форм и диаграмм. Такие формы приходится показывать в виде картинок.
Требуется определенный уровень квалификации для кастомизации версии Dita.


[size=150:1q43wktr]Принцип единого источника в DITA[/size:1q43wktr]


Принцип единого источника позволяет поддерживать один источник документа, из которого публикуются различные вариации этого источника.

[u:1q43wktr][i:1q43wktr]DITA поддерживает принцип единого источникак посредством[/i:1q43wktr]:[/u:1q43wktr]

[list:1q43wktr]* Возможности многократно использовать контент
* Профилирования и фильтрации контента
* Публикации во множество форматов из одного источника[/list:u:1q43wktr]

[u:1q43wktr][i:1q43wktr]В DITA контент может много кратно использоваться на следующих уровнях:[/i:1q43wktr][/u:1q43wktr]
[list:1q43wktr]Контент внутри топика
Топик в целом
Карта документа[/list:u:1q43wktr]
DITA позволяет профилировать контент с помощью атрибутов. Фильтрация контента осуществляется с помощью фильтров, определяемых в формате *.ditaval.

Контент может быть опубликован из DITA во множество форматов, включая PDF, HTML Help, XHTML, RTF с помощью DiTA OT.

[size=150:1q43wktr]Многократное использование контента на уровне топика[/size:1q43wktr]

Контент внутри топика может быть многократно использован посредством:
[list:1q43wktr]* Профилирования контента.
* Вставки определенного контента из одного топика в другие топики.
* Многократное использование топика.[/list:u:1q43wktr]
Добро пожаловать на форум Dita!
 
А как тут можно сделать иерархию тем или постов ? Создать новую тему, а дальше ?
Хотелось бы написать несколько постов без комментариев, а уж потом обсуждать. Чтобы не замылилась тема среди комментов.
Кто займется переводом документации по DITA?
 
[quote="ЮВ":2oqekc5o] как я уже писал, используя бесплатный Eclipse я получю документацию в 5 форматах.
Технология DITA  нужна для совсем других целей. [/quote:2oqekc5o]
Чего лезть в тему перевода доки по Dita со своим эклипсом ? Скорее на уровень выше нужно..
[quote="ЮВ":2oqekc5o]
У каждой затеи (в том числе и с DITA) должна быть экономическая целессобразность
(если, конечно, речь идет о собственных деньгах, а не деньгах клиентов),  или,
говоря "научно",  технико-экономическое обоснование.  
[/quote:2oqekc5o]
Вот один из примеров затрат на обучение технологии http://www.suite-sol.com/pages/services/dita_qs_ws_nc_october_2010.html

[quote="writer":2oqekc5o][quote="ADVANCED":2oqekc5o] Создал группу на Facebook для русскоязычных пользователей Dita, хочу выкладывать инфу там.[/quote:2oqekc5o] А почему бы не сделать здесь? Я могу сделать отдельный раздел под это дело, если Вам это будет интересно. На Facebook не все зарегистрированны(.[/quote:2oqekc5o]
Мне интересно предоставить информацию из СВОЕГО ЛИЧНОГО опыта, ПОДЕЛИТЬСЯ знаниями, которые получил, а не продавать их, помочь кому-либо в освоении не простой технологии. Доказывать, что экскаватор лучше лопаты или что-то обосновывать - некогда. Для этого есть куча других форумов.
Кто займется переводом документации по DITA?
 
Так кто займется переводом документации по DITA? :-)
Кто займется переводом документации по DITA?
 
[quote="ЮВ":3cw5rydf]
Автор, по простоте душевной, назвал  истинную причину того, почему DITA у нас не "бороздит космические дали" - технология  не востребована в реальной жизни, на практическом уровне,  остановилась на уровне хобби (типа ловля бабочек, коллекционирование винных этикеток и т. п.,  т. е. воспринимается как нечто несерьезное, как модное увлечение, которое со временем пройдет и на смену ему придет другое).[/quote:3cw5rydf]

Нет, немного не так. Технология востребована очень даже. Технология используется компаниями для подготовки документации в разных форматах.
Я же назвал ее своим хобби, потому что на работе засиживаюсь долго из за нее, прихожу домой  опять Dita, и днем и ночью форумы, переводчики, документация по XSL, ANT. Никто не понимает что это, а я ей постоянно занят. И мне интересно. Я помогаю ее настраивать другим людям бесплатно, хотя мог бы зарабатывать на этом, но мне это не надо, т.к., опять же, это мое увлечение, а не основной источник дохода. Мне нравится переписывать куски кода на свой лад.
[quote="ЮВ":3cw5rydf]
остановилась на уровне хобби.[/quote:3cw5rydf]
АГА!  Когда технология изучена на достаточном для работы уровне, появляется желание что-то подкрутить и доработать. Узнать что-то новое, применить знания и помочь кому-то.
Только это не технология остановилась, а "автор" вырос профессионально ;-)
А у вас она не "бороздит", видимо потому, что "фирма заплатит за уже настроенный продукт, че заморачиваться" . :-)
Кто займется переводом документации по DITA?
 
[quote="writer":2dalbjh3]А почему бы не сделать здесь? Я могу сделать отдельный раздел под это дело[/quote:2dalbjh3]
Да можно и здесь... Только, сами понимаете, - нужно время. Работа с Dita уже стала моим хобби, но и основной работы выше крыши.. Описание может растянуться на долго.
Создавайте раздел ;-)
Кто займется переводом документации по DITA?
 
А какова цель перевода? Там же десятки тысяч страниц. Мне кажется, достаточно описать как ее устанавливать и настраивать по минимуму для работы с кириллицей. Ну еще можно описать основы для работы с PDF и CHM. Именно этим пытаюсь заняться уже пару недель. Создал группу на Facebook для русскоязычных пользователей Dita, хочу выкладывать инфу там.
Уведомление об обновлении информации
 
[quote="ЮВ":2kzqz98n]В целях экономии времени желательно на главной странице рядом с названием рубрики ("Форум", "Вакансии", "Новости" и т. п.) проставлять дату и время последнего обновления в ней информации.
[/quote:2kzqz98n] Так есть же ссылка "Активные темы" (в левом верхнем углу над списком форумов). Там они и выстраиваются "в ряд" по времени обновления.
Какой выбрать софт для автоматической верстки?
 
[quote="ЮВ":3fzkjnbw][quote="ADVANCED":3fzkjnbw]... АNT и несколько инструментов [/quote:3fzkjnbw]
Eclipse использует ANT, поддерживает репозитарий для
версионного хранения  программ и текстовых файлов, обеспечивает их коллективную разработку.[/quote:3fzkjnbw]
Не спорю. Но Eclipse - во-первых, слишком громоздкая среда для создания документации (другое дело, если программисты в ней работают и для документирования используют утилиты javadoc).
Во-вторых, из эклипса не "вытащить" автоматическую публикацию, т.е. без участия человека. Для каждого документа нужно что-то нажимать и проверять.
Какой выбрать софт для автоматической верстки?
 
[quote="DIX2005":3owc2l2x]Помогите разобраться. Начальство поставило задачу автоматизировать выпуск документации для ПО, в котором предполагается частое обновление функций.
Есть группа разработчиков в разных городах нашей необъятной родины, которые пишут некий софт и параллельно ведут его документирование в едином файле: инструкция в виде HTML-страницы с кучей перекрестных ссылок (что-то типа wiki). Документ обновляется каждый день, в том числе и литературным редактором. Так вот нужно к выходу каждой новой версии ПО за пару дней из этого HTML сделать красивый PDF + CHM. Уверен, что задача не нова, но сталкиваюсь с ней впервые, поэтому прошу помочь. Бюджет неограничен.[/quote:3owc2l2x]

DITA Open Toolkit, АNT и несколько инструментов - позволят автоматизировать выпуск документации без привязки к авторам, бесплатно и круглосуточно.
1. Делаем сервер, например, в Москве. Ставим Tortoise SVN и разворачиваем репозитории для версионного хранения текстовых файлов. Открываем доступ для изменений всем программерам. Они могут создавать, изменять и сохранять файлы с любой точки планеты в одно место.
2. На этом же сервере ставим Dita Open Toolkit. Настраиваем для публикации "красивого HTML, PDF, CHM, doc".
3. Пишем скрипты, которые "постоянно мониторят" изменения в сервере SVN и, при нахождении обновления хотя бы одного файла, запускают публикацию новой версии документации.
... типа:
   <target name="getCurrentTrunkRevision">
       <checkCurrentRevision revisionproperty="svn.trunk.revision.current" lastrevision="${last.trunk.build}" conditionproperty="trunk.revision.new" username="${svn.username}" password="${svn.password}" url="${svn.root.url}/trunk"/>
   </target>

Результаты могут выкладываться на серваке, отправляться по почте на кучу адресов и т.п. У нас в компании дополнительно формируется текстовый релиз версии. Также можно сделать публикацию по запросу программистов, пользователей и кого угодно, через веб-интерфейс с учетом прав, поставив несколько флажков и нажав одну кнопку.

На локальные машины ставится бесплатный Tortoise SVN и редактор XML. Авторы-программисты во Владивостоке, Самаре, Питере и Калининграде пишут текст в XML-редакторе по шаблонам (это проще чем в эклипсе, больше им заморачиваться ничем не надо), коммитят файлы в репозиторий SVN в удобное для них время и живут спокойно.

В это время в Москве, пока народ спит, "искусственный интеллект" <macrodef name="changeVersion"> обнаруживает, что предыдущая версия  изменена одним или несколькими файлами, выгружает все файлы из репозитория в папку публикации  antfile="${get.revision.script}" dir="${build.dir}" и запускает публикацию последней версии.
После публикации пишутся логи, сообщения на почту всем подписанным (типа RSS канала) и куда сохраняются результаты.


Максимальный "гемор" - а) написать скрипты и роботы, которые мониторят изменения между версиями в svn-репозитории и б) кастомизировать Dita под свой формат и стиль PDF+CHM. Но т.к. инструменты все бесплатны, а бюджет не ограничен - можно нанять XML разработчика на пару недель/

P.S.
Если не нужно так детально отслеживать изменения, то можно сделать назначенное задание в Windows, которое будет в определенное время запускать batch-скрипт и документация будет собираться независимо от изменений. Т.е. как ни крути всегда будет доступна наиболее актуальная редакция.
Пофестивалим?
 
Цитата
Это кафе стилизованное под советскую столовку..
Те, кто пишет по ГОСТам, будут чувствовать себя в своей тарелке  :P
Пофестивалим?
 
Давайте думать где территориально.
Есть хорошее место Столовая № 57. Находится на 3-м этаже ГУМа. Цены приемлемые, не дороже чем в средней столовой г.Москвы. Название не означает что там отвратительно. Это кафе стилизованное под советскую столовку.. Кругом плакаты "Требуйте сосиски", "Требуйте долива после отстоя пены" и т.п )) Есть даже автомат с газировкой, только 5 рублей вместо 3-х копеек.
Поесть можно, выпить что душа пожелает...мороженого поесть, ну и пообщаться, разумеется. Как плюс - в центре Москвы.
Пофестивалим?
 
Цитата
Ну скорее всего в Москве))в каком нибудь парке или кафе.

Можно попробовать когда жара спадет ;-)
xmlmind - кто-нибудь работал?
 
[quote="latex":3gdofr4w][quote="ADVANCED":3gdofr4w]

13. Условно бесплатный[/quote:3gdofr4w] т.е платить за него нужно? Сколько стоит?[/quote:3gdofr4w]

Personal Edition - бесплатная.
Professional Edition - около 400 долларов. В Professional есть настройки Dita и Docbook, открываются дополнительные меню для генерации документов прямо из редактора.
Космические корабли бороздят диту, DITA и DocBook что выбрать?
 
[quote="writer":1ljolf9n]
Самые общие принципы установки и настройки, думаю многим будет интересно, такая документация по DITA просто отсутствует на русском языке.[/quote:1ljolf9n]
Она и отсутствует потому, что неясно как написать...времени нужно вагон и не факт, что будет понятно кому-то. Показать намного проще..
Космические корабли бороздят диту, DITA и DocBook что выбрать?
 
[quote="ADVANCED":38a0at19]
Даже если собрать все в архив и поставить, разархивировав на другой машине - не факт что будет работать.[/quote:38a0at19]

Вот часто встречаются вопросы на тему документации Dita на русском языке... А ее написать то практически не возможно. Сложного ничего нет. Есть непонятности в описании всего процесса.
[LIST]
[*]а) Установить = просто распаковать архив.
[*]б) Добавить инструменты для работы JDK, ANT = у всех по разному. Кто-то использует Java из Oracle, кто-то не жалеет дискового пространства и ставит самую новую. Опять же переменные Java_home, Ant_home у всех по разному.
[*]в) Прописать параметры в скриптах сборки документации - опять по разному. Можно не использовать оригинальную версию Dita, а написать свои скрипты.
[/LIST]
Я бы показал при случае...но боюсь голову оторвут  :D  , ведь этим кто-то на хлеб зарабатывает :roll:
Космические корабли бороздят диту, DITA и DocBook что выбрать?
 
[quote="гена":mdw4krqd] Мощная штука, интересно будет даже просто попробовать..пощупать так сказать..[/quote:mdw4krqd]

В том то и дело, что по умолчанию DIta сконфигурирована таким образом, чтобы обрабатывать один источник в один формат параметрами из командной строки. Дальше дело фантазии и рук с мозгами, ну и xslt, xml и синтаксис ANT. Раз есть командная строка и XML, то можно писать батники, создавать свои переменные и настраивать output.
Даже если собрать все в архив и поставить, разархивировав на другой машине - не факт что будет работать.
Космические корабли бороздят диту, DITA и DocBook что выбрать?
 
[quote="Светусь":2u29s9jv][quote="ADVANCED":2u29s9jv]А разве то, что делают редакторы с исходниками после компиляции и преобразований годится заказчикам? Я имею ввиду стили, границы, шрифты и т.д.[/quote:2u29s9jv]

Годится во Flare, в том-то и дело. Там замечательно можно настроить всё до мелочей, и стили свои прописать. На самом деле, очень неплохой результат получается. О DITA думаем, потому что во Флер не все нужные нам форматы хэлпа поддерживаются, и накладки с потворным использованием некоторых файлов требуют больше времени.[/quote:2u29s9jv]


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

В моем случае редактор - это только средство для "набивания текста" и добавления различных атрибутов для обработки этого текста. При чем, как бы не хотел писатель изменить форматирование, у него ничего не получится. Есть принятый стиль, - значит только этот стиль.
Все остальное прописывается в сценариях обработки и преобразований. Так же пишутся скрипты для упрощения и понятности логики другим (менее опытным) писателям. В итоге все упрощено до такой степени, что получить документацию может кто  угодно, где угодно, по любой версии, для любой аудитории, оформленные нужным стилем (ГОСТ не ГОСТ), А4, А5, цветные/ч/б и т.д...
Космические корабли бороздят диту, DITA и DocBook что выбрать?
 
[quote="latex":39w35gu7]
Вах! Вот об этом не знал, раньше вроде и руссификатора то не было, не то что проверки орфографии. Спасибо за информацию.[/quote:39w35gu7]

Начиная с версии 4_5_2. Уже доступна 4_6_0   http://www.xmlmind.com/xmleditor/download.shtml
Пофестивалим?
 
Цитата
А может нам устроить вечеринку, а?


А повод - просто гульнуть в хороший теплый летний солнечный вечер?  :)


Или может подумаем на счет регулярных вечеринок "Всероссийский съезд тех.писателей" для обмена опытом, расширения проф.контактов, "что - где - по чем".  :shock:
Космические корабли бороздят диту, DITA и DocBook что выбрать?
 
[quote="Ана":3dwakl88]а вот с компиляцией - хотелось бы все иметь в одном флаконе, как-то привыкли, что Флер делает все[/quote:3dwakl88]

По моему недавно вышел Xmetal 6.0. Много чего может делать сам из предустановленных компиляторов. НО дорого стоит.
Можно скачать trial с сайта на 30 дней.

А разве то, что делают редакторы с исходниками после компиляции и преобразований годится заказчикам? Я имею ввиду стили, границы, шрифты и т.д.
Пофестивалим?
 
А где ? Надо место "пересечений" придумать.
Страницы: Пред. 1 ... 62 63 64 65 66 67 68 69 70 71 72 След.

Рейтинг@Mail.ru