Разработка технической документации и технические писатели Технические писатели и разработка технической документации технические писатели в Телеграм 

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
Ответить
RSS
Добавление указателей в help, как правильно создавать указатели в help
 
Здравствуйте.
При описании хелпа возник вопрос:
Что выносить в Указатели в хелпе, а что нет, нужна ли вложенность?

Понаписала названий страничек в указатели, но мне кажется, что ерунда получилась.
Если одна и та же фраза может склоняться либо сокращаться, то стоит ли писать все варианты???
Скрытый текст

Использую Help&Manual 6.
 
Доброго времени суток!
При вынесении указателей Вы сами должны решить, что там может потребоваться пользователю, а что нет - этот вопрос остается за Вами. Вложенность просто необходима, без нее теряется смысл иерархической структуры указателей (нас интересует связь между родительским (Master Keyword ) и дочерними элементами (Child Keyword)) - тогда отпадает необходимость писать все варианты склонений и сокращений (под один элемент, например "списания" (родительский элемент - "акт"), мы указываем все топики содержащие "акт списания", "акты списания", "акт спис.", "акт списан." и т.д.):
P.S.: И не забывайте давать какое-нибудь "нормальное" название своему файлу справки, а то "Help" (в вашем случае) выглядит несексуально.
P.P.S.: По всем вопросам, связанных с H&M6 - добро пожаловать в соответствующую тему:
Изменено: 'H&M User' - 03.07.2013 12:39:15
 
Цитата
'H&M User' пишет:
связь между родительским (Master Keyword ) и дочерними элементами (Child Keyword)) - тогда отпадает необходимость писать все варианты склонений и сокращений (под один элемент, например "списания" (родительский элемент - "акт" ;) , мы указываем все топики содержащие "акт списания", "акты списания", "акт спис.", "акт списан." и т.д
Большое спасибо за ответ ).
Хотелось бы уточнить, как сделать Master Keyword и Child Keyword.
Если я в Keywords перечисляю указатили (разделяю их переносом строки) - они Master?
А как сделать Child? "Якорями"?

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

P.S. С названием у меня вышла очень смешная история, я на вкладке Title & CopyRight заполнила все поля, так чтобы наименование генерировалось (сейчас уже точно не помню как), и программа сама пробел не добавляла между словами из двух полей, тогда я его доставила то ли вначале, то ли в конце поля и на какое-то время забыла об этом.
А потом хелп неожиданно перестал собираться, что только не пробовали, не могли понять в чём проблема, он ещё выдавал в качестве ошибок кракозябры, потом один из коллег расшифровал кракозябры и выяснилось, что проблема в том пробеле была (((.
Я и потёрла нафиг значения в полях и оставила лаконbчное "Help".
 
И в очередной раз, дописав в Title фразу "КАИС "Алекс Групп" - User Help" после сборки у меня запустился хелп с заголовком "КАИС", с одной единственной страничкой и без панельки навигации слева.
 
Ну как вот теперь не ответить такой красивой девушке!? Все, я околдован и пленен чарами голубых глаз...  :)  
Добрый день!
Цитата
'' Волвенко пишет:
Хотелось бы уточнить, как сделать Master Keyword и Child Keyword.
Обычно, для таких целей лучше использовать Index Tool:

Сначала создаем Master Keyword, а уже затем его "деток" (выбор всех нужных топиков и, если необходимо, с указанием якорей):


Цитата
'' Волвенко пишет:
Я и потёрла нафиг значения в полях и оставила лаконbчное "Help".
Мудрое решение!  :)  Но лучше сделать так:
1) Перейти в Configuration -> Common Properties -> Help Windows;
2) Для поля Title bar text задать значение "КАИС "Алекс Групп" - User Help".
В результате выполненных действий получим (шкурка - Twoframe_Classic_Skin_Blue из папки HTML skins):

Изменено: 'H&M User' - 04.07.2013 13:12:36
 
Цитата
'' Волвенко пишет:
с одной единственной страничкой и без панельки навигации слева
Проверьте пожалуйста, все ли необходимые флажки выставлены на следующей вкладке (Configuration -> Common Properties -> Help Windows):
Изменено: 'H&M User' - 04.07.2013 13:18:13
 
Спасибо большое и за ответ, и за комплимент  :)  .
1. Удалось сделать заголовок хелпа: "КАИС "Алекс Групп" - User Help".
2. С Master Keywords и Child Keywords разобралась.

3.
Цитата
'H&M User' пишет:
Проверьте пожалуйста, все ли необходимые флажки выставлены на следующей вкладке ( Configuration -> Common Properties -> Help Windows ):
Все настройки, как у вас на скриншоте.

И ещё один, очень мучающий меня вопрос, как же всё таки правильнее с указателями.
Например, есть топик, описывающий документ с названием "Складская уценка".
При описании Keywords для этого топика, будет ли уместно добавить следующее:
Код
документ
   складская уценка
складская уценка
уценка товара 
складские документы
   складская уценка
("складская уценка" может быть создана сразу из двух справочников "складские документы" и "складская уценка", ну и при этом она всё равно остаётся просто документом)
или достаточно:

Код
 документ
   складская уценка

Всё не как не могу решить сколько же стоит синонимов использовать и стоит ли.
Сколько вообще ссылок должно быть на один и тот же топик целиком?
Изменено: '' Alphiria - 05.07.2013 03:26:15
Страницы: 1
Ответить
Читают тему
Форма ответов
Текст сообщения*
Загрузить файл или картинкуПеретащить с помощью Drag'n'drop
Перетащите файлы
Ничего не найдено
Загрузить файлы
Отправить Отменить