CftClub.ru
Клуб специалистов ЦФТ-Банк

Пользовательская документация ЦФТ
На страницу 1, 2  След.
 
Ответить на тему    Клуб специалистов ЦФТ-Банк (IBSO) -> Документация ЦФТ-Банк
Предыдущая тема :: Следующая тема  
Автор Сообщение
hirundo
Участник
Неподтвержденный


Вступление в Клуб: 12.07.2016
СообщениеВт Июл 12, 2016 12:41   Пользовательская документация ЦФТ Ответить с цитатой
Полезность: 1
Приветствую всех.

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

Если вам есть что сказать, пишите, пожалуйста:

- понимаете ли вы нашу пользовательскую документацию;

- видите ли вы, что ведутся работы по улучшению;

- устраивают ли вас предлагаемые нами форматы chm и pdf или нужны дополнительные, например, docx, epub и пр.;

- интересно ли вам создание так называемых "быстрых стартов" в начале каждого документа (экспресс-описание основных действий, которые вам как пользователю нужно сделать, не вдаваясь в подробности, например: "Инструкция “Ф-303 Расчет Быстрый старт” поможет Вам за короткое время научиться, как рассчитать данные и создать файл для отправки в ЦБ - зайдите, выберите, нажмите, посчитайте, отправьте в ЦБ);

- интересна ли вам в перспективе документация в формате wiki;

- есть ли документация, которую вы расцениваете как эталонно хорошую и эталонно нечитаемую;

...

- другие трудности, о которых мы не подозреваем.
svn
Профи
<Банки (менее 3 участников)>


Вступление в Клуб: 04.02.2008
СообщениеВт Июл 12, 2016 14:17    Ответить с цитатой
Полезность: 1
1. необходим глобальный поиск по всей документации по ключевым словам
2. реализовать контекстную помощь по всем типам ЦФТ банк - тут мне кажеться нужен глобальный перерасчет индексов - очень часто нажимаем вызов помощи, а в ответ для типа токого то справки нет
3. реализовать автоматическое обновление файлов документации при накате обновлений - аналогично как происходит например с шаблонами отчетов
4. добавить информацию о зависимости от приложений - лучше сразу ссылкой на сайт ЦФТ
5. больше информации идеалогического, концептуального характера
nobel
Участник - экстремал
Неподтвержденный


Вступление в Клуб: 28.09.2011
СообщениеВт Июл 12, 2016 14:45    Ответить с цитатой
Полезность: Нет оценки
От себя скажу что порой не хватает в документации настройки разных вещей(для примера создание нового вида задолженности и что с ним связанного)

Касательно приложений то соглашусь.Например включается какую то настройку согласно документации и в конце месяца узнаешь что включил новое приложение которое не куплено.Хотя бы было описание в начале документации и в ключевых моментах что для "включения" операций(справочников,настроек и прочего) необходимо то или иное приложение.

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

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


Вступление в Клуб: 19.09.2007
СообщениеВт Июл 12, 2016 17:53    Ответить с цитатой
Полезность: Нет оценки
Нужна документация, адаптированная к пониманию простыми исполнителями/операционистами/кассирами и т.д. в части оптимальной эксплуатации Навигатора. Работа с представлениями/фильтрами и т.д. Естественно - никто из них не читает пространно-заумное описание по F1.
jobber
Участник
Неподтвержденный


Вступление в Клуб: 07.09.2012
СообщениеСр Июл 13, 2016 02:19    Ответить с цитатой
Полезность: Нет оценки
В документации не хватает подробного описания каких-то процессов вплоть до все проверок. Постоянно приходится смотреть код операций потому что понять почему система не работает так как написано в документации невозможно - открываешь код и видишь что оказывается применена куча каких-то условий и доп. параметров о которых в пользовательской документации по описанию операции ни слова не сказано.
yaffil
Профи
Неподтвержденный


Вступление в Клуб: 18.08.2011
СообщениеСр Июл 13, 2016 10:32    Ответить с цитатой
Полезность: Нет оценки
jobber пишет:
Постоянно приходится смотреть код операций потому что понять почему система не работает так как написано в документации невозможно - открываешь код и видишь что оказывается применена куча каких-то условий и доп. параметров о которых в пользовательской документации по описанию операции ни слова не сказано.


Да ладно, не встречал такого, можете пример привести?
Да доки слишком дофига, да, порой, в ней трудно найти даже ИТ нужную главу, а юзеру вообще анриал (в 16.3 наткнулся на справочник код операции - название доки в которой она описана - это явный плюс, не знаю была ли раньше такая штука), дока порой глупая до безобразие типа, операция открыть счёт - открывает счёт, дата открытия - это дата открытия счёта, ну и так, наверное 70% доки. Опять таки из за этого ни ИТ ни юзеры доку редко смотрят.
Но 90% проблем пользователей я решаю тупо по доке чуть ли не прямым текстом.
Gobur
Участник - экстремал
Неподтвержденный


Вступление в Клуб: 06.11.2012
СообщениеСр Июл 13, 2016 11:45    Ответить с цитатой
Полезность: Нет оценки
Volod пишет:
Нужна документация, адаптированная к пониманию простыми исполнителями/операционистами/кассирами и т.д. в части оптимальной эксплуатации Навигатора. Работа с представлениями/фильтрами и т.д. Естественно - никто из них не читает пространно-заумное описание по F1.

Плюсану. Сейчас все в одной(и для админа и для пользователя) и если отдать пользователю - он видит много ненужной информации.
vtar
Эксперт
Неподтвержденный


Вступление в Клуб: 20.03.2009
СообщениеСр Июл 13, 2016 18:02    Ответить с цитатой
Полезность: 1
С моей точки зрения, не хватает конкретных примеров настройки по типовым бизнес-процессам банка, мало где они есть.

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


Вступление в Клуб: 09.11.2015
СообщениеЧт Июл 14, 2016 07:16    Ответить с цитатой
Полезность: Нет оценки
yaffil пишет:
...дока порой глупая до безобразие типа, операция открыть счёт - открывает счёт, дата открытия - это дата открытия счёта, ну и так, наверное 70% доки...

Замечу, что это гораздо лучше, чем
- Дата создания - дата, когда договор начал действовать
- Дата начала действия договора - дата, когда договор был создан

А такое реально есть Sad
hirundo
Участник
Неподтвержденный


Вступление в Клуб: 12.07.2016
СообщениеЧт Июл 14, 2016 08:30    Ответить с цитатой
Полезность: Нет оценки
См. вложениеДата архива: 14.07.2016 08:30
Размер архива: 655.74 КБ

Эмиралька, yaffil
"Дата создания - дата, когда договор начал действовать".
Да, есть такие описания, знаем... По стандартам, если описывается экранная форма, в описание должны быть включены все реквизиты/параметры. Зачастую про дату больше нечего написать. Пока как вариант: не добавлять пояснения для очевидных реквизитов, ограничиться перечислением. Подойдёт?

vtar
"не хватает конкретных примеров настройки по типовым бизнес-процессам банка, мало где они есть"
Можете написать название документа, в котором вы такие примеры видели и они вам понравились?
Добавляю вложение с нашим пилотным вариантом инструкции для рядового пользователя. Что-то подобное мы хотим добавить перед основным разделом в каждом нашем документе. Посмотрите, интересен ли будет такой вариант.

Gobur, Volod
Для начала мы хотели бы добавить в документацию раздел "Быстрый старт", в котором будет описана последовательность действий для обычного пользователя, которому надо, например, рассчитать отчет, и у которого нет времени разбираться в теории, что как получается. Посмотрите вложение, устроит ли такой подход или хочется чего-то другого?
Кроме этого, есть вариант компилировать два вида документов - для обычного пользователя и для пользователя продвинутого, но вопрос, насколько это удобно. Больше сущностей - больше хаоса.

jobber
Здесь однозначно не могу ответить. Возможно, это связано с тем, что документация всё-таки ориентирована на обычного пользователя. Можете написать пример из доки: что вы прочли и после прочтения чего полезли в код? И наоборот: что вы прочитали и всё поняли после прочтения? Так будет более понятен желаемый уровень детализации.

nobel
В документации отчетной подсистемы мы добавили в разделе "Общая информация" перечень используемых приложений (см. вложение). Это похоже на то, что хотелось видеть?
описание логики работы комиссий по кредитам когда переходили на 446п и разделяли их на операционные и неоперационные
Можете название документа написать - где смотреть?

svn
Контекстная справка - однозначно да, работаем над этим.
По остальным идеям подумаем.

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

nobel
Участник - экстремал
Неподтвержденный


Вступление в Клуб: 28.09.2011
СообщениеЧт Июл 14, 2016 11:00    Ответить с цитатой
Полезность: Нет оценки
Вот эта документация про которую я говорил-https://support.cft.ru/446/Pages/default.aspx(файл Рекомендации по учету процентных комиссий по кредитам с низкой категорией качества).

По поводу формата документации то мы у себя в банке используем chm и порядка человек 10 точно ею пользуется у нас в банке(за исключением нашего отдела).Пользуемся главным образом в электронном виде.В бумажном виде нужно как правило на совещаниях если нужно представить что именно так работает ИБСО(небольшая вырезка из документации).

Еще хотелось бы добавить по поводу документации-какое то условное разделение для обычных пользователей и для администраторов/программистов.А то получается ни нам программистам не хватает то что есть и обычным пользователям не все далеко понимают и спрашивают у нас.Например разделение в рамках одной документации(в одном файле два раздела) или два разных файла.
Volod
Профи
Неподтвержденный


Вступление в Клуб: 19.09.2007
СообщениеЧт Июл 14, 2016 14:58    Ответить с цитатой
Полезность: Нет оценки
По поводу отношения обычных юзеров к документации расскажу - внедрил перед запуском Навигатора короткие подсказки (Tips) из документации по Навигатору, со ссылкой на соответствующие разделы файла chm, сделал галочку - "Не показывать в дальнейшем",
и что вы думаете - все радостно эти галочку поставили, а вьюхи как висят часами, так и висят Smile
Эмиралька
Профи
Неподтвержденный


Вступление в Клуб: 09.11.2015
СообщениеПн Июл 18, 2016 12:11    Ответить с цитатой
Полезность: Нет оценки
hirundo пишет:
Эмиралька, yaffil
"Дата создания - дата, когда договор начал действовать".
Да, есть такие описания, знаем... По стандартам, если описывается экранная форма, в описание должны быть включены все реквизиты/параметры. Зачастую про дату больше нечего написать. Пока как вариант: не добавлять пояснения для очевидных реквизитов, ограничиться перечислением. Подойдёт?

Нет, не пойдёт.
Я, например, только недавно узнала, что дата открытия лицевого счёта - это не просто дата открытия лицевого счёта.
На самом деле это дата создания лицевого счёта, которая в момент открытия перезаписывается на дату открытия. В этот же момент открытия лицевого счёта обобщённый статус меняется с TO_OPEN на <ПУСТО>.
Такие нюансы хочется видеть по всем реквизитам ТБП, полям ЭФ и полям представлений.
KhrushchevAV
Участник со стажем
<Банки (менее 3 участников)>


Вступление в Клуб: 17.10.2014
СообщениеВт Авг 02, 2016 08:34    Ответить с цитатой
Полезность: Нет оценки
Сколько людей - столько мнения. Пользователям нужно одно, IT-шникам другое, администраторам третье.
Может и правда, зря разные понятия одним словом называем и обсуждаем?

Сомневаюсь, что в этом форуме Вы услышите мнение пользователей.
От себя (от IT-шника) могу сказать следующее:
Меня просто бесят описания экранных форм. Я это и так вижу на экранной форме! А понять "КАК ОНО РАБОТАЕТ?!" документация совершенно не помогает. Только время отнимает. Crying or Very sad Если рядом нет человека, который УЖЕ знает, остается два пути 1) эксперимент, т.е. метод тыка; 2) посмотреть код, как уже заметили коллеги;
Еще проще, зачастую, просто написать свой код. Ну это уже к вопросу документации не очень относится.

P.S. Не хочу ни кого обидеть. Написание документации - это тяжелый и не благодарный труд.
Selenka
Участник - экстремал
<Центр Финансовых Технологий>


Вступление в Клуб: 07.04.2009
СообщениеПт Авг 19, 2016 08:32   Опрос по пользовательской документации ЦФТ Ответить с цитатой
Полезность: Нет оценки
Коллеги, добрый день!

Спасибо за ваши комментарии в этой теме. Мы их читаем, стараемся замечания учесть. Тема с переработкой пользовательской документации зрела уже и внутри ЦФТ, а активность здесь, на CftClub, подтвердила, что задача по улучшению качества документации для продуктов ЦФТ актуальна.

Со вчерашнего дня на сайте Службы сопровождения стартовал официальный опрос с целью получения обратной связи от банков по пользовательской документации. И мы уже получаем первые заполненные анкеты. Будем благодарны, если вы примите участие. Сам опросник небольшой, его заполнение не займет много времени.
Показать сообщения:   
Ответить на тему    Клуб специалистов ЦФТ-Банк (IBSO) -> Документация ЦФТ-Банк Часовой пояс: GMT + 3
На страницу 1, 2  След.
Страница 1 из 2

 
Перейти:  
Вы не можете начинать темы
Вы не можете отвечать на сообщения
Вы не можете редактировать свои сообщения
Вы не можете удалять свои сообщения
Вы не можете голосовать в опросах
Рейтинг@Mail.ru