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

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

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

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

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

Страницы: Пред. 1 ... 59 60 61 62 63 64 65 66 67 68 69 ... 72 След.
Бесплатные программы для создания документации.
 
[quote="chaosteorist":39fxf15t] ADVANCED может посоветуете с чего начать в DITA и Docbook. Можно англоязычные сайты, техническим английским владею хорошо.[/quote:39fxf15t] Смотря на что развели начальство. Инструмент для работы с XML или непосредственно конвертации dita2fomat?
DITA - формат RTF
 
[quote="Teux":b5r90z3k]Как вариант, можно использовать конвертер из FO в RTF или ODT http://www.xmlmind.com/foconverter/
Для целей практики он бесплатный[/quote:b5r90z3k]Помнится, Teux, вы как-то высказывались против XMLMind :) Что привело к рассмотрению бесплатных инструментов?
Ищем технического писателя (Абсолют Банк, Москва)
 
Test.mail@mail.ru
Недавно смотрел мультик Простоквашино.Не обижайтесь...
Ищем технического писателя (Абсолют Банк, Москва)
 
[quote="Mavr_ABS":ep0iwp0i]В Департамент Информационных Технологий Абсолют Банка требуется технический писатель.
Заработная плата 65 000 рублей gross.[/quote:ep0iwp0i]А некоторые и мышей едят.Маловато.[quote="Mavr_ABS":ep0iwp0i]Контакт:
Максим Врублевский
электропочта: m.vrublevskiy(гав-гав)absolutbank.ru
телефон: +7 (495) 995 1001 доб. 52305[/quote:ep0iwp0i]А здоровье у меня не очень: то лапы ломит, то хвост отваливается.
P.S.
Собака @@@@ же нормально @@@@  отображается во всех форумах, включая PHP.
Ссылки и кнопки
 
[quote="Ogre":3s5ghix1]Это ужасно. Мне жалко ваших пользователей.[/quote:3s5ghix1]Зачем изобретать велосипед, если все уже написано до нас. Если ваш продукт работает с БД Oracle, вы описываете установку и настройку Oracle или ссылаетесь на оригинальную документацию?
Бесплатные программы для создания документации.
 
К вашему сожалению, H&M пробовал один раз, установил, потестил и удалил. Тоже самое и с FrameMaker.
[b:urdr2kdq]Dita - она как виски, лучше в чистом виде![/b:urdr2kdq] :D

Ссылки вот:
http://tech.groups.yahoo.com/group/dita-users - группа пользователей Dita со всех концов света.
http://www.ditamap.com/tools.php
http://www.hyperwrite.com/Articles/showarticle.aspx?id=65
http://www.ibm.com/developerworks/xml/library/x-dita4/index.html

Документация к самой Dita есть на многих ресурсах на английском языке.
Ссылки и кнопки
 
[quote="puhata":2zuxx25l]И если принимать во внимание "недалекость" пользователя, то он просто не поймет, что значит "перейти по ссылке", а "нажать" дает руководство к конкретному действию.[/quote:2zuxx25l]С таким же успехом пользователь по команде "нажать" может ткнуть пальцем в монитор )))
В документации должны быть условные обозначения и сокращения. В исключительных случаях можно написать что означает "нажать кнопку" "нажать левой кнопкой мыши", "нажать правой кнопкой мыши", "перейти по ссылке" и так далее.
[quote="Ogre":2zuxx25l]Документацией вы должны научить пользователя. В том числе и корректной терминологии. Некоторые пользователи думают, что компьютер — это монитор. А системный блок — это железная коробка непонятного назначения.[/quote:2zuxx25l] НИЧЕГО ПОДОБНОГО!!! [b:2zuxx25l]Это их проблемы[/b:2zuxx25l] :twisted: . Вы - Технический писатель и пишете руководство пользователя системой или ПО. По умолчанию подразумевается что пользователь обладает навыками работы с ПК. Если нет, даже по ненавистным всем ГОСТам предусмотрен раздел, в котором перечисляются требования к навыкам, персоналу.

Не стоит нагружать всяким хламом документацию, типа "В далёком феврале 1946 года мир узнал о том, что в США запущен первый в мире электронный компьютер...". Эти знания даются в школах и вузах. Даже самый [color=#FF0000:2zuxx25l]тугой[/color:2zuxx25l] пользователь никогда не устроится на работу с компьютером, не зная что такое мышь и как ей пользоваться. Для престарелых пользователей бывает обучение и аттестация ([b:2zuxx25l]для "недалеких" чиновников недавно устраивали[/b:2zuxx25l]). И в руководстве пользователя ПО не должно быть советов обслуживанию, правильному выключению компа, настройке яркости монитора, протиранию пыли. Даже не должно быть информации о настройках Windows и безопасности. Это проблемы администраторов и руководства. В документации пользователя должна быть описано его программа, начиная с момента авторизации (аутентфикации, логина).
Доступ к секретным стандартам
 
[quote="puhata":3vqqouc8]Коллега, разрабатывал в свое время документацию для МВД, на некий тех. аппарат. Так вот документацию не принимали нормоконтролеры этого самого МВД, требовали оформление по неким ГОСТам, доступ к которым был только у них. [/quote:3vqqouc8] Я 2 года разрабатывал документацию для разных подразделений МВД. Ни о каких странных ГОСТах не слышал, все как везде. Единственное только требование было, чтобы документация передавалась в формате doc, PDF им непонятен, а Doc чем-то надежнее.
Доступ к секретным стандартам
 
По вопросам связанным с использованием архивных материалов, необходимо обращаться с письменным заявлением в Центральный архив ФСБ России (101000, г.Москва, ул. Б.Лубянка, д.2), указав в нем свой почтовый адрес и домашний телефон.

Это так, шутка... А откуда информация именно про "секретные" стандарты? Может иностранные, типа ISO ?
Ссылки и кнопки
 
[quote="Memfis":1wggxhxu]Я понимаю, что в основном переходят) Но "нажимать ссылку" вроде тоже вполне допустимо, разве нет?[/quote:1wggxhxu]Да, чтобы перейти по ссылке, надо сначала ее нажать )))
Еще можно "щелкать" от англ. Click. Но кликать и щелкать как-то не прижилось в официальных документах, разве что на форумах и различных статьях.
[quote="Ogre":1wggxhxu][quote="гена":1wggxhxu]Также))
нажмите ссылку
Выберите ссылку и т.д[/quote:1wggxhxu]
Вообще-то по ссылке переходят, если чо )[/quote:1wggxhxu] Вообще-то это зависит от GUI. В Web-интерфейсе все может зависеть от настроек браузера, например, переходить по ссылке при одном наведении. Или кнопка в виде ссылки, которая визуально не нажимается, а только выделена другим цветом.
В появившемся окне...
 
В открывшемся окне, в открывшемся диалоге, на открывшейся вкладке выберите, сделайте или укажите
Файл справки CHM и сетевой диск
 
[quote="Alex23":2dkptnsd]оказывается прилагается дополнительный файл в виде отдельного патча, который как раз исправляет этот недостаток на копмьютерах ХР[/quote:2dkptnsd] Это делается 1 раз для одной ОС Windows XP. Наверное можно администратору настроить это для всех компов в локальной сети, но это не относится к techwriters, это должны быть проблемы администратора локальной сети.
[quote="Alex23":2dkptnsd]Однако я не могу найти информацию касательно [u:2dkptnsd]Windows 7[/u:2dkptnsd]. Помогите пожалуйста с Windows 7.[/quote:2dkptnsd]http://www.nextwindows.ru/forum/
Бесплатные программы для создания документации.
 
[quote="гена":3gkcsb34]Я бы из бесплатных ничего не советовал, больше проблем. Ищите ломанные версии.[/quote:3gkcsb34]
Согласен по поводу бесплатных. [quote="chaosteorist":3gkcsb34]в IT-организации занимающейся созданием и сопровождением софта [/quote:3gkcsb34] В таких организациях нужно либо ставить тяжелый в освоении софт, либо покупать дорогие лицензии не скупясь, т.к. документация - часть продукта, за который организация получает деньги, а с этих денег менеджер проекта получает зарплату :D
Файл справки CHM и сетевой диск
 
[quote="Alex23":1fhuogx0]Я не компилирую на сетевом диске. Я делаю компиляцию на своем жестком диске, а потом переношу скомпилированный файл справки на сетевой диск путем копирования файла справки.[/quote:1fhuogx0] Я не говорил про компиляцию.
[quote="Alex23":1fhuogx0]Если можно поподробне про то как разблокировать файл и про параметры безопасности тоже. Я так поняла мне нужно делать разблокировку файла после того как я его скопирую на сетевой диск для всех[/quote:1fhuogx0]
Нет, для всех вы ее не сделаете. Это проблема Майкрософт (http://support.microsoft.com/kb/896054).
[b:1fhuogx0]Разблокировку должен делать каждый, кто читает файл по сети[/b:1fhuogx0]. Разблокировку для всех подобных файлов в будущем можно сделать изменив 2 ключа в системном реестре на:
[code:1fhuogx0][HKEY_LOCAL_MACHINESOFTWAREMicrosoftHTMLHelp]
[HKEY_LOCAL_MACHINESOFTWAREMicrosoftHTMLHelp1.xItssRestrictions] "MaxAllowedZone"=dword:00000001
[/code:1fhuogx0]
Если файл копируется с сетевого диска на локальный, то в свойствах файла (по правой кнопке мыши) появляется кнопка "Разблокировать". [b:1fhuogx0]Такая разблокировка применяется только к этому файлу и только локально[/b:1fhuogx0].

Это особенности OC Windows и формата CHM. Выбирайте другие форматы и переходите на кроссплатформенные инструменты.
Добавление в проект других файлов
 
[quote="Alex23":27b8pwne]Обучать меня так же некому[/quote:27b8pwne] Google.ru
Dita htmlhelp
 
Еще можно посмотреть все строки WARNING и ERROR в логе, выкладывайте.
Файл справки CHM и сетевой диск
 
Никак. Если получится изменить параметры безопасности на локальном компьютере, то у других пользователей останется проблема с отображением. СHM не будет читаться по сети.
После копирования с сетевого диска на локальный диск, надо в свойствах файла "разблокировать" файл.
Такой вот замороченный "маздай".
Dita htmlhelp
 
[quote="Nata":26sp6gso]Вот вся проблема в том что в этом файле все переведено :([/quote:26sp6gso]быть может вы не используете локализацию ru_RU? Где-нибудь при запуске build указывается язык ru? Если нет, то можно попробовать исправить в файле \ditaot\xsl\common\strings-en-us.xml строку [code:26sp6gso]<str name="Parent topic">Parent topic</str>[/code:26sp6gso]Но это не точно, обычно все меняется как писал ранее.

[quote="Nata":26sp6gso]Возникла ошибка. Помогите, пожалуйста, решить
BUILD FAILED[quote="Nata":26sp6gso]C:\DITA-OT1.5.3\plugins\plus-allhtml-svgobject\build_plus-allhtml-svgobject.xml:216: C:\DITA-OT1.5.3\${treediagram2svg.js.root} not found.[/quote:26sp6gso][/quote:26sp6gso]
где-то криво задана переменная ${treediagram2svg.js.root}  ????
Как организовать работу отдела документирования?
 
Мы говорим на разных языках. Я вообще не понимаю как можно править PDF и сохранять его разные промежуточные версии. Наверное ПДФ делается из Ворда или каких-то других систем разработки документации?? Если в ворде, то можно изменения хранить в самом файле (в 2007 исправления и изменения) пока не будет завершено редактирование и не обязательно хранить 100 файлов с именами от 001 до 100 с разными стандартами.

Если из других систем, то можно хранить исходники Subversion, он бесплатен, но полезен только для ""не бинарных" файлов. Встроенные утилиты позволяют посматривать изменения ( с подсветкой разницы).

Если есть тестирование документации по файлу ПДФ, то не стоит его переименовывать каждый раз с новым именем. Изменять исходники, хранить их в Subversion, а ПДФ собирать после каждого изменения - всегда последняя версия. Subversion позволяет откатить назад любые изменения до любого момента, если последняя версия не удалась, то легко откатываемся назад. Почитайте в нете. Я его не рекламирую, просто работаю с текстовыми исходниками много лет, с вордом работал, но не делал множество копий с обновлениями.

Или если я все не так понял, расскажите, плз, о каких версиях вы говорите :) В качестве обмена опытом.
Как организовать работу отдела документирования?
 
[quote="Ogre":1d7nll2s]Причем тут расширение файла?[/quote:1d7nll2s] Текстовые файлы свободно обрабатываются любыми системами контроля версий. Файл загружается на сервер, в его каталоге создаются системные файлы с хранением истории изменений. В любой момент времени можно посмотреть кто и что изменял путем сравнения двух ревизий файла без каких либо коментариев (см. SVN, Mercurial и т.п.)
Бинарные файлы (pdf, doc, jpg, gif, zip, exe и другие варианты, не обязательно документации) так обрабатываться не могут, т.к. нет программ для сравнения, за некоторыми исключениями.

[quote="Ogre":1d7nll2s]Простите, я не понимаю о чем вы говорите. Есть документ, он "живет" на файлсервере. Надо каким-то образом отслеживать его версионность.[/quote:1d7nll2s] Я говорю о том, что с бинарными файлами работать сложнее. Надо либо писать изменения вручную, о чем можно забыть или "забить", либо хранить их в системе контроля версий просто с индексами. В индексах также описывать изменения вручную, на что также можно забить/забыть.
Грубо говоря, есть 10 файлов PDF + 1 readme.txt, в котором написано кто что когда изменял. Изменил документ, будь добр запиши что ты изменил, когда и зачем :D
Как организовать работу отдела документирования?
 
[quote="Ogre":5nbcgz6f]Не вижу связи с форматом.[/quote:5nbcgz6f] Расскажите как можно хранить изменения в файле PDF от версии к версии? Этот момент не встречали никогда.
Как организовать работу отдела документирования?
 
[quote="Ogre":18t0gap0]При таком подходе в самом документе необходимо прописывать историю: версия 015 — внесены изменения по резултатам проверки тестеровщиками; в раздел 5.2.8 добавлена информация о подключении переферийных устройств; раздел 4.5.11 удален, информация из него перенесена в 8.12.13. Ну и т. п.[/quote:18t0gap0]А если документ в PDF, то так просто не получится.

С файлами DOC проще - Microsoft Office SharePoint. Файлы загружаются на сервер, откуда доступ регулируется правами. Позволяет хранить историю изменений для каждого файла (только ее надо ручками прописывать или хранить в режиме исправлений). Позволяет блокировать файл в то время, как он редактируется другим пользователем. Посмотрите, там много разных возможностей, правда стоит такое ПО недешево.
DITA pdf формат
 
[quote="Arven":glxz6s9j]А не в файл front-matter-attr.xsl?[/quote:glxz6s9j] Да, в него. Извиняюсь, могу путаться с названиями файлов, т.к. не использую их вообще. Для всех изменений лучше делать кастом-файлы. Вы изменяете исходные файлы dita?

[quote="Arven":glxz6s9j]А вот например для подзаголовка я в ru_RU задала переменную
, а в во Front-matter.xsl ничего менять не надо?[/quote:glxz6s9j] Надо, но я не угонюсь за всеми переменными. Пример приведен выше, можно по аналогии делать что угодно.
Главное чтобы:
а) была [b:glxz6s9j]переменная[/b:glxz6s9j]: факт ее наличия и место куда она подставляется задается в шаблонах типа [b:glxz6s9j]<xsl:template name=[/b:glxz6s9j]"insertFrontMatterEvenFooter">
б) была [b:glxz6s9j]настройка[/b:glxz6s9j] этой переменной (как отображать блок с переменной), задается в атрибутах типа [b:glxz6s9j]<xsl:attribute-set name=[/b:glxz6s9j]"__frontmatter__title">
в) был [b:glxz6s9j]текст[/b:glxz6s9j] переменной (или ссылка, картинка, нумерация и т.д.), задается в настройках типа [b:glxz6s9j]<variable id=[/b:glxz6s9j]"Appendix with number">Приложение <param ref-name="number"/></variable>

[quote="Arven":glxz6s9j]ADVANCED писал(а):
3. Сам номер писать в теге топика.
Это как понять?)[/quote:glxz6s9j] [quote="ADVANCED":glxz6s9j]
.. надо определиться с типом тега, которым будет выделяться тот или иной блок.
Подзаголовок и версия оформляются каким-либо из тегов в Bookmeta или topicmeta (в зависимости от типа карты Bookmap или Ditamap).
Тег <****meta> содержит в себе большую иерархию других тегов, которыми можно оформить подзаголовок. Для версии наиболее подходящий <vrmlist><vrm version="???"></vrm></vrmlist>. Для подзаголовка можно взять например, <prodname><wintitle></wintitle></prodname>. [/quote:glxz6s9j] Открыть редактор, в нем открыть файл *.dita (*.xml), в файле добавить нужный тег и написать в нем номер версии или подзаголовок.
Dita htmlhelp
 
1. Найти файл \ditaot\demo\fo\cfg\common\vars\ru_RU.xml
2.  Найти строку
[code:uthmr9ap]
   <variable id="Parent topic">Parent Topic</variable>[/code:uthmr9ap]3. Поменять текст на свой
Как организовать работу отдела документирования?
 
а в чем она хранится?
Страницы: Пред. 1 ... 59 60 61 62 63 64 65 66 67 68 69 ... 72 След.

Рейтинг@Mail.ru