Как создавать и обновлять справку в Ax2009

[Владимир Максимов]

Как создавать и обновлять справку в Ax2009? Можно ли использовать старый функционал SysHelpOverview или только HTML?

[Poleax]

Создание Help System со страницы 1-10 (тренинг) AX2009_ENUS_DEVIII_01.pdf

[Владимир Максимов]

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

[gl00mie]

Видимо, да, только зачем же добавлять статью в стандартные CHM-файлы? С ними возни много, глядишь, с каким-нить rollup'ом обновятся, чего доброго, - придется все переделывать. Проще, по-моему, свой отдельный файл завести.

[Владимир Максимов]

Надо понимать так, что никто и никогда не пишет справки по собственному функционалу? "Не царское это дело"?

[Ivanhoe]

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

[Владимир Максимов]

Ну, создали Вы новую настроечную форму. Разве Вы не пишите краткую справку о том, для чего эта форма нужна и где используются сделанные в ней настройки?

Создали новый отчет. Разве Вы не пишите что именно этот отчет выводит, по какому алгоритму отбирает и формирует данные, что обозначают те или иные настройки в этом отчете?

Неужели все "настолько очевидно" по внешнему виду? Или каждый пользователь всегда обращается к "руководству пользователя" и начинает судорожно искать где же там описание нужной формы/отчета?

[gl00mie]

Цитата:

Сообщение от Владимир Максимов

Ну, создали Вы новую настроечную форму. Разве Вы не пишите краткую справку о том, для чего эта форма нужна и где используются сделанные в ней настройки? Создали новый отчет. Разве Вы не пишите что именно этот отчет выводит, по какому алгоритму отбирает и формирует данные, что обозначают те или иные настройки в этом отчете?

А как вы представляете себе того пользователя, который будет эту справку читать? Зашел эдакий Семен Семеныч в Аксапту с полными правами доступа, начал по формам/отчетам тыкаться да справку читать, чего такого полезного с их помощью можно сделать, да?
Обычно новые настроечные формы и отчеты создаются не от нечего делать, а по конкретному запросу от пользователей, которым нужен новый функционал, либо от консультантов, кроме которых те же настроечные формы подчас никто и не увидит. Так вот, пользователи обычно заранее примерно представляют чего они хотят и чего получат в результате, поэтому справку какую-то отдельную рисовать им не надо, а для новых сотрудников есть инструкции и, может, даже видеоуроки, где наглядно все показано и рассказано. Я лично еще люблю проверять те же формы на неподготовленных пользователях - смогут ли разобраться без подсказки; это, по-моему, неплохой "тест на вшивость" для дизайна формы и реализованного взаимодействия с пользователем.

[Владимир Максимов]

Вообще-то, как ни странно, справка нужна скорее разработчику, чем пользователю. Хотя и пишется так, чтобы пользователю было достаточно понятно. Пользователь вобще никогда и ничего не читает Описываю то, с чем я постоянно имею дело.

Присылают запрос: почему вот в этом отчете вот такие цифры, а вот в этом - другие?

Ответ простой, именно потому, что отчеты разрабатывались под разные требования и, соответственно, использовали разный алгоритм расчета. Хотя поля отчета называются совершенно одинаково, что, собственно, и вводит в заблуждение пользователя.

Но это если знаешь ответ. А если не знаешь? Оба отчета разрабатывали X лет тому и все разработчики и заказчики уже благополучно уволились? Читать ТЗ и инструкции? Ну, и где они эти ТЗ и инструкции? Названия-то хоть известно? С момента создания этих отчетов структура каталогов и архивов менялась столько раз, что и не упомнишь. Да и кому интересны те ТЗ, если отчеты многократно переписывались? Какое из множества разных ТЗ нужно?

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

С другой стороны, справка, вызываемая по F1 всегда "под рукой". Ее просто нельзя потерять. Разве что, вместе с системой. Поэтому, либо сам быстро "пробегаешься" по справке и объясняешь все пользователю, либо, если пользователи очень уж "достали" можно просто сказать: нажмите F1 и читайте в чем отличие.

С настроечными формами другая проблема. С течением времени они обрастают огромным количеством разных полей, смысл которых теряется "в глубине веков" . И опять встает вопрос документирования что за что отвечает. Все "внешние" (по отношению к Axapta) источники еще надо найти (и не факт, что они вообще есть).

Другими словами, несмотря на то, что справка пишется вроде как для пользователя, реальную пользу она приносит именно аналитикам и разработчикам.

[George Nordic]

Насколько я понимаю, проекты делаются (ну по крайней мере, должны ) в соответствии с методологией.
Рекомендуемая методология для внедрения Dynamics AX - Microsoft SureStep
Насколько я помню методологию, там есть раздел "Внедрение", который подразумевает подготовку инструкций пользователей и их обучение.
Насколько я помню методологию, в ней ничего не сказано про компиляцию CHM-справки.

С Уважением,
Георгий

[Владимир Максимов]

Мой опыт показывает, что справка нужна не столько для внедрения, сколько для сопровождения системы. Внедренцу-то что, он сделал свое "черное дело" и ушел . А мне с этим надо как-то дальше работать

PS: Ничего удивительного, что нет ни слова про CHM. Это слишком неудобно для модификации справки. Лучше уж "по старинке" через SysHelpOverview. Тем более, что она вполне нормально работает и в Ax2009. Надо только исправить парочку глюков, тянущихся с Ax2.5

[Ivanhoe]

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

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

[Владимир Максимов]

Цитата:

Сообщение от Ivanhoe

На своих проектах всегда веду реестр модификаций прямо в системе, с приложенными заданиями на разработку.

Это как? Можно чуть подробнее?

[Ivanhoe]

Самописная система регистрации модификаций с привязкой к стандартным проектам разработки. В принципе ничего не мешает вести реестр в отдельном трекере, системе HelpDesk и т.п. Да хоть и в Excel - было бы желание.

Просто в вашей идее ведения хелпа, кроме решения стандартных проблем с плохой документацией (отстутствует, не актуальна, не достаточна и т.п.), придется решать технические проблемы - те же файлы справки делать.

[oip]

Справкой не пользуемся. У нас вот так: в Аксапте написан некий баг-трекер, в котором (в том числе) есть как полное описание задачи с ТЗ, так и ссылка на проект в Аксапте.

Чтобы узнать, в рамках какой (каких) модификаций менялся некий объект, достаточно простейшего джобика, который пробежится по всем проектам и составит список проектов, в которые данный объект входит. Дальше фильтр по баг-трекеру и вуалля, есть полный список модификаций, затрагивающий данный объект. Это для особо сложных случаев. В более простом случае достаточно посмотреть на метку модификации в коде, которая обязательно ссылается на проект приложения. Далее опять лезем в трекер и читаем ТЗ.

Основная проблема тут в том, что старые задания со временем теряют актуальность, поэтому иногда читать приходится "нарастающим итогом".

[Владимир Максимов]

Цитата:

Сообщение от Ivanhoe

Самописная система регистрации модификаций с привязкой к стандартным проектам разработки. В принципе ничего не мешает вести реестр в отдельном трекере, системе HelpDesk и т.п. Да хоть и в Excel - было бы желание.

Не понял фразу насчет "привязки". Вот есть узел в AOT. И? Что и как к нему "привязывается"? Это вся система привязки вне Axapta или внутри?

Цитата:

Сообщение от Ivanhoe

Просто в вашей идее ведения хелпа, кроме решения стандартных проблем с плохой документацией (отстутствует, не актуальна, не достаточна и т.п.), придется решать технические проблемы - те же файлы справки делать.

Нет. Делать файлы справки как раз-таки не придется. Я имел в виду вполне стандартный функционал. Открываете новую форму (у нее еще нет справки), далее жмете F1 и в открывшемся окне кнопку "Правка". Можно писать любую контекстную справку. Это все будет сохранено внутри Axapta. Эту справку можно переносить стандартными XPO (правда, для новых объектов в 2 этапа) через экспорт/импорт.

Справка пишется по мере необходимости и при внесении модификаций. В основном, для не стандартного функционала.

[Владимир Максимов]

Цитата:

Сообщение от oip

Справкой не пользуемся. У нас вот так: в Аксапте написан некий баг-трекер, в котором (в том числе) есть как полное описание задачи с ТЗ, так и ссылка на проект в Аксапте.

Можно чуть подробнее. Что из себя чисто физически представляет этот самый "баг-трекер в Axapta" который может содержать некий текстовый документ? Я так понял этот текст хранится именно внутри Axapta, а не во-вне?

Основная проблема - это факт хранения документации вне Axapta. Как следствие, проблема поиска. Пока справка внутри Axapta самый оптимальный вариант хранения описания.

[oip]

Текст задания хранится на VSS в виде документа Word. Из соответствующей задачи баг-трекера открывается нажатием кнопки. О какой проблеме поиска идет речь?

[Владимир Максимов]

Цитата:

Сообщение от oip

О какой проблеме поиска идет речь?

Самой прямой и непосредственной. Как определять где именно лежит нужный документ и лежит ли он вообще.

Цитата:

Сообщение от oip

Текст задания хранится на VSS в виде документа Word. Из соответствующей задачи баг-трекера открывается нажатием кнопки

"Баг-треккер" - это функционал Ax2009?

[oip]

Не-не, трекер нами написан. Если к задаче прикреплено ТЗ, то оно открывается из VSS нажатием кнопки. Ничего искать не надо.