Оставить заявку

H&M User (Все сообщения пользователя)

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

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

Страницы: Пред. 1 ... 3 4 5 6 7 8 9 10 11 12 13 След.
мы в ответе, за то что мы написали?, ответсвенность
 
[QUOTE]tech_writer_1 пишет:
А я считаю, что в документации надо описывать ровно то, что есть в ПО[/QUOTE]И даже это иногда не годится... Недавно было: обновил файлы руководства по свежей версии ПО и по ним сделал пакет документации. Когда почитали ПЗ и руководства - выпучили глаза и сказали, что этого в ГК не было! Все убрать и описать только то, что в ГК! (за все нововведения еще можно много лет деньги получать отдельными контрактами :))
ТЭО
 
Вместо 24.101-80 используем 34.201-89. А все ГОСТ 24.2** вошли в один руководящий документ: РД 50-34.698-90. Для Вашего случая, либо делаем вместо ТЭО отчет для стадии "Формирование требований к АС" (там есть раздел 1.9. Раздел "Ожидаемые технико­экономические результаты создания АС" ;)  по РД 50-34.698-90, либо (если все-таки ТЭО требуют) делаем свой документ (содержание по 24.202-80, называем ТЭО и оформляем по 2 или 19 ГОСТ, как и весь остальной комплект).
Изменено: 'H&M User' - 29.07.2013 15:54:13
help context numbers и snippets, использование сниппетов в Help&Manual
 
У Вас это не сниппет получается, а топик, куски которого вы используете в качестве сниппетов. Я имел ввиду использование внешних файлов,  не подключенных к проекту вообще.
Первый способ. Создаем сниппет:

и подключаем его как внешний файл:

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

Первый способ позволяет использовать якоря и help context number. Самого же файла в проекте нет и быть не должно. А для удобства подключения можно использовать репозиторий, по крайней мере в 6й версии:
Изменено: 'H&M User' - 29.07.2013 15:11:02
help context numbers и snippets, использование сниппетов в Help&Manual
 
[QUOTE]'Максим' пишет:
поставьте для файла сниппета  Include in Build - none  (те убрав все виды публикаций) и ссылка сразу же перестанет работать....[/QUOTE]Хм, а как поставить - у меня же этого файла в проекте нет! Да и не должно быть, это же сниппет и в проекте он не нужен - нужна лишь ссылка на него. Этот xml-файл подключается к результирующему документу во время публикации (или множество файлов, для Вашего случая, каждый блок - это отдельный сниппет, сохраненный как xml-файл. И для каждого абзаца блока можно создать якоря).
Изменено: 'H&M User' - 26.07.2013 18:25:05
help context numbers и snippets, использование сниппетов в Help&Manual
 
Доброго времени суток, Максим!
Сейчас проверил, работает ли ссылка на якорь, находящийся в сниппете - работает!
Сделал так:
[LIST=1]
[*]Добавил xml-файл сниппета к проекту для удобства редактирования;
[*]Вставил якорь на нужный абзац содержимого сниппета, указав его Anchor ID (запоминаем!) и уникальный номер Help Context;
[*]Сохранил отредактированный xml-файл как сниппет (и сейчас его уже можно отключать от проекта);
[*]Добавил сниппет в топик;
[*]Вставил ссылку на якорь сниппета - в качестве Target использовал ID топика со сниппетом, а якорь ВВЕЛ ВРУЧНУЮ (так как в списке якорей его не будет, H&M не видит якоря в режиме Snipped is linked).
[/LIST]
Изменено: 'H&M User' - 26.07.2013 17:53:49
Оформление документации без рамок
 
[QUOTE]Мария К пишет:
спасибо! Сделала с рамками. Нужно было по 34 ГОСТу[/QUOTE]:) По 34 ГОСТ понятие растяжимое... "По 34-му" - означает оформление по ГОСТ 2, либо можно использовать 19, если разрабатываются документы для программных средств ВТ.
Оформление документации без рамок
 
[QUOTE]Мария К пишет:
Можно ли оформлять документацию технического, рабочего проектов без рамок. Дайте пжл. ссылку на ГОСТ, где об этом говорится.[/QUOTE]К примеру, если мы оформляем документацию, используя ГОСТ 19.106-78 "Требования к программным документам, выполненным печатным способом", то в изм.1 п. 2.1.2 видим:
"Информационная и основная части программного документа выполняются по форме 1 или 2, где:[LIST]
[*]поле 1 - порядковый номер страницы;
[*]поле 2 - обозначение документа;
[*]поле 3 - текст документа;
[*]поле 4 - строка изменений; заполняется в соответствии с требованиями ГОСТ 19.604-78.
[/LIST][B]Рамку (границы) формата страниц документа допускается не наносить."[/B]
Изменено: 'H&M User' - 22.07.2013 18:51:44
Всплывающие посказки в Help and Manual
 
Хм... Вроде бы все правильно, за исключением Help Context: попробуйте удалить этот номер.
Изменено: 'H&M User' - 18.07.2013 16:45:33
Всплывающие посказки в Help and Manual
 
[QUOTE]Alex_Gur пишет:
К сожалению, я не знаю, что такое popid_480240700 . Как можно это узнать?[/QUOTE]Элемент на вашем скриншоте ошибки выполнения сценария. Сделайте пожалуйста скриншот topic options вашего popup-топика.
Изменено: 'H&M User' - 18.07.2013 15:03:53
Всплывающие посказки в Help and Manual
 
Ясно, тогда скажите, popid_480240700 - это Ваш id всплывающего топика или имя xml-файла топика, который используется в качестве всплывающего?
Всплывающие посказки в Help and Manual
 
[QUOTE]Alex_Gur пишет:
При создании в Help and Manual всплывающей подсказки (типа JavaScript popups ) появляется следующее окно. С чем это может быть связано?
 [/QUOTE]Проверьте, правильно ли выбран класс для данного топика:

и все настройки:
Типовая таблица в Help Manual, Как сделать стандартный стиль "Примечание"
 
[QUOTE]tech_writer_1 пишет:
То, что нужно) а эти стили хранятся в шаблоне?
И еще вопрос - векторные форматы (svg) поддерживаются?[/QUOTE]Стили могут храниться в самом проекте. Если используются "шкурки" (*.hmskin, при генерации chm и html), то там уже могут быть свои стили. Насчет поддержки векторных форматов - напрямую нет. Хотя, был случай, когда мне понадобилось использовать кусок векторной карты MapInfo - просто закинул ее как OLE-объект.
Вызов всплывающей подсказки JavaScript из приложения
 
Вызов топика в виде всплывающей подсказки:
{
 GetFullFileSpec ("имя файла справки", cDLLName, cHelpCall);
 HtmlHelp(hwndApp, cHelpCall, HH_DISPLAY_TEXT_POPUP, (DWORD)Topic);
  return 0; }
 return 0;
}

или через HTMLHelp API:
HtmlHelp(m_hWnd, m_pszHelpFilePath, HH_HELP_CONTEXTPOPUP, ByVal CLng(TopicID));
Изменено: 'H&M User' - 17.07.2013 16:16:16
Типовая таблица в Help Manual, Как сделать стандартный стиль "Примечание"
 
[QUOTE]tech_writer_1 пишет:
Например, у меня есть в тексте примечание, которое оформлено в рамочку, с картинкой "восклицательный знак". Такие примечания встречаются часто во всём комплекте документов. Могу я одним движением руки изменить картинку и цвет рамочки, чтобы это всё изменилось во всём комплекте документации?[/QUOTE]Давайте попробуем...
Итак, по всему тексту у меня имеются следующие таблицы (имеющие табличный стиль, к примеру, Attention и AttentionText):


Если я желаю изменить значок и рамки всех этих таблиц, то просто меняю текущие стили (первый - для пиктограммы, второй - для границы):

[TABLE]

[TR][TD]таблица Attention:
[/TD][TD]таблица AttentionText:
[/TD][/TR]

[/TABLE]

В результате, по всему проекту имеем, к примеру, следующее:
[LEFT]

P.S.: В примере используется таблица из одной строки и двух столбцов. В первой ячейке находится другая таблица (без рамок и текстового оформления, имеет отличный от первой таблицы стиль для задания пиктограммы фона).
P.P.S.: Текст, находящийся внутри нашей таблицы, также должен быть одного текстового стиля, чтобы имелась возможность изменить и его.
[/LEFT]
Изменено: 'H&M User' - 08.09.2014 15:28:07
Отличия H&M от других подобных инструментов, Обсуждаем отличие программы Help Manual
 
[QUOTE]''ADVANCED'' пишет:
Принципиальное отличие в том, что без редактора H&M и установленной среды в WINDOWS пользователь мало что сделает.
[/QUOTE]Если бы я работал с DITA, наверное сделал бы так:
1) Создал и отредактировал hmxp, xml, xsd и xsl (hmxp - это обычный xml);
2) Создал папку Maps с файлом table_of_contents.xml и папку Topics с xml-файлами топиков;
3) Создал ini-файл с нужным содержимым, например create_pdf.ini:
[CODE]PDF=F:\Help Project\PDF\User_guide.pdf
I=PDF,FINALBUILD
Template=gost34.mnl
TSK=Special
L=F:\Help Project\Logs\publishlog.txt
[/CODE]4) И в консоли ввел: HELPMAN.EXE "D:\Help Project\User_guide.hmxp" create_pdf.ini.
 :)
Изменено: 'H&M User' - 12.07.2013 17:53:53
Отличия H&M от других подобных инструментов, Обсуждаем отличие программы Help Manual
 
[QUOTE]''ADVANCED'' пишет:
И оба коммитят изменения. Эта возможность очень полезна и используется ежедневно разработчиками кода.[/QUOTE]Для этого в H&M используются системы контроля версий.
Отличия H&M от других подобных инструментов, Обсуждаем отличие программы Help Manual
 
[QUOTE]tech_writer_1 пишет:
Только вроде бы версия должна быть серверная или еще какая-то.
[/QUOTE]Для многопользовательского редактирования нужна Professional. Основное отличие Server от Pro - это наличие единственной сетевой инсталляции и использование "плавающей" лицензии для совместной работы (при запуске H&M на рабочей станции терминального сервера требуется серверная лицензия).
Отличия H&M от других подобных инструментов, Обсуждаем отличие программы Help Manual
 
[QUOTE]''ADVANCED'' пишет:
В Dita есть набор XML-файлов и стили, которые могут быть преобразованы как угодно и кем угодно: на сервере, по сети, удаленно, на чужой машине, без каких-либо установленных сред, по расписанию, в разных операционках. Редактировать файлы можно также как угодно и где кому нравится не зависимо от операционной системы и навыков автора.

[/QUOTE]Кто Вам мешает таким же образом редактировать файлы и стили проекта H&M (несжатый XML)? Поэтому, основным отличием H&M от DITA является наличие WYSIWYG-оболочки.
Отличия H&M от других подобных инструментов, Обсуждаем отличие программы Help Manual
 
[QUOTE]tech_writer_1 пишет:
Под совместной работой лично я понимаю, что документ дробится на топики, и в одно время несколько писателей работают с разными топиками. Потом они всё это коммитят на сервер.
А насчёт формата файлов - в H&M вроде ведь тоже xml? кто в курсе?
[/QUOTE]Под совместной работой в H&M понимается не только одновременное редактирование топиков одного проекта, но и редактирование разными пользователями дочерних проектов, с последующей сборкой в мастер-проект.

[QUOTE]''ADVANCED'' пишет:
Но что с ним потом делать не известно. А так там особым образом сжатый XML, примерно как SVG, DOCX и т.п.[/QUOTE]В H&M есть два формата проектов:
- единый файл-хранилище (стандартный ZIP-архив) - *.hmxZ;
- несжатый XML - *.hmxP;

Для многопользовательского редактирования используется [B]ТОЛЬКО[/B] hmxP, потому как представляет собой набор файлов (файл проекта в HMXP, структура проекта в XSD и таблица стилей xslt в XSL) и папок (Baggage, Maps (содержание в XML) и Topics (все XML-файлы топиков)).

[QUOTE]tech_writer_1 пишет:
В том и проблема - в первоначальной настройке шаблона оформления нерядовым техписом[/QUOTE]При многопользовательском редактировании, когда используется "модульный" проект, это проблема никогда не возникает, так как стили мастер-проекта применяются ко всем дочерним проектам динамически. Мастер-проект, в свою очередь, может представлять собой репозиторий, в котором уже настроены все стили или скопированы от шаблонного проекта. А один раз выполнить WYSIWYG-настройку шаблона не так уж и сложно, как кажется.
Изменено: 'H&M User' - 12.07.2013 17:21:30
Отличия H&M от других подобных инструментов, Обсуждаем отличие программы Help Manual
 
[QUOTE]'writer' пишет:
По-моему раньше HM не поддерживал технологию единого источника[/QUOTE]Ради этой технологии его и создавали :)
Под технологией единого источника понимается использование одного проекта для создания множественных версий Вашей документации в различных форматах, т.е. для H&M всего лишь:

[TABLE]

[TR] [TD][/TD] [TD][LEFT][/LEFT][/TD] [/TR]

[/TABLE]


[LEFT]
[/LEFT]
Тестируем новый форум, Все замеченные на форуме ошибки выкладываем здесь. Будем искать, разбираться и исправлять. Всем спасибо за помощь!
 
[QUOTE]''''writer'''' пишет:
что касается форума с HM то он здравствует, только адрес поменялся на вот этот [url]http://www.techwriters.ru/forum/forum636/[/url]
[/QUOTE]Хм... странно, пишет, что этот форум для меня закрыт... Забанили? :o
Тестируем новый форум, Все замеченные на форуме ошибки выкладываем здесь. Будем искать, разбираться и исправлять. Всем спасибо за помощь!
 
Добрый день, Уважаемые!
Хотелось бы спросить, что случилось с форумом H&M?  (http://www.techwriters.ru/forum/forum590/)
Изменено: 'H&M User' - 09.07.2013 11:40:09
как избавиться от нумерации приложений в help&manual?, Разбираемся с нумерацией страниц в help&manual
 
[QUOTE]Гость пишет:
в тексте вставляете ссылку на раздел, главу и тд в виде см. п. 2.6? стоит заморачиваться или достаточно оставлять просто слово со ссылкой на нужный раздел документа. Это все применимо для документов pdf и rtf. по Госту вроде должны быть....
[/QUOTE]Добрый день, Гость! :)
Вопрос хороший, если брать ГОСТ, то:
[LIST]
[*]2.105-95, п.4.2.22 "В текстовом документе допускаются ссылки на данный документ, стандарты, технические условия и другие документы при условии, что они полностью и однозначно определяют соответствующие требования и не вызывают затруднений в пользовании документом. ... Ссылаться следует на документ в целом или его разделы и приложения. Ссылки на подразделы, пункты, таблицы и иллюстрации не допускаются, за исключением подразделов, пунктов, таблиц и иллюстраций данного документа. ...";
[*]19.106-78, изм. №1 п.2.5.1: "... Ссылаться следует на документ в целом или на его разделы (с указанием обозначения и наименования документа, номера и наименования раздела и приложения). При повторных ссылках на раздел или приложение указывают только номер. ...".
[/LIST]Вышесказанное означает, что ссылка должна выглядеть как "см. подраздел 3.2.1 Описание интерфейса", а при повторном упоминании - "см. подраздел 3.2.1".

Однако, так как документы, которые мы формируем в виде rtf, doc|docx и pdf, являются простыми электронными документами (документ, реализованный в виде одного файла, который содержит в себе все необходимые для своей интерпретации данные) согласно ГОСТ 2.051-2006 по ИСО 10303-21, а chm, hlp и html - агрегированными электронными документами (интерактивное электронное техническое руководство, представляющее совокупность информационных единиц в виде модулей данных, выполненных в форме набора файлов с гипертекстовой разметкой) по ИСО 8879. А для агрегированных электронных документов, согласно того же ГОСТ 2.051-2006, Приложение А, п.4.5, "доступ к информационным единицам при визуализации содержания документа осуществляется по ссылкам между содержательными частями" и "связь между информационными единицами осуществляется по взаимным ссылкам", т.е., в Вашем случае - "просто слово со ссылкой на нужный раздел документа"  :)
Изменено: 'H&M User' - 05.07.2013 11:38:51
как избавиться от нумерации приложений в help&manual?, Разбираемся с нумерацией страниц в help&manual
 
[QUOTE]'Максим' пишет:
Можно по подробнее?  :)  
[/QUOTE]Ну конечно!!! :)
Итак...
1) В Excel создаем или копируем структуру документа, сохраняя уровень вложенности;
2) Путем склеивания счетчиков и содержимого столбцов с наименованием топиков создаем конечное пронумерованное содержание;
3) Копируем полученное пронумерованное содержание и вставляем в Multiple Topics.
Результат:

[TABLE]

[TR][TD][/TD][TD][/TD][/TR]

[/TABLE]
Изменено: 'H&M User' - 04.07.2013 13:46:28
Добавление указателей в help, как правильно создавать указатели в help
 
[QUOTE]'' Волвенко пишет:
с одной единственной страничкой и без панельки навигации слева[/QUOTE]Проверьте пожалуйста, все ли необходимые флажки выставлены на следующей вкладке ([B]Configuration -> Common Properties -> Help Windows[/B]):
[CENTER][/CENTER]
Изменено: 'H&M User' - 04.07.2013 13:18:13
Страницы: Пред. 1 ... 3 4 5 6 7 8 9 10 11 12 13 След.

Рейтинг@Mail.ru