Предыдущая тема :: Следующая тема |
Автор |
Сообщение |
kai Профи
Вступление в Клуб: 16.08.2012
|
Вт Сен 11, 2012 05:59  01_Интерфейсы_YY_VER.chm; 02_Сервисы ПЯ_YY_VER.chm |
|
Полезность: Нет оценки
|
Народ!
а кто-нибудь читает %тему ?
Файлы "Справка по интерфейсам системы" и "Справка по сервисам прикладного ядра" кому-нибудь пригодились хоть раз ?
 |
|
 |
lexus Профи
Вступление в Клуб: 28.09.2007
|
Вт Сен 11, 2012 11:05  Re: 01_Интерфейсы_YY_VER.chm; 02_Сервисы ПЯ_YY_VER.chm |
|
Полезность: Нет оценки
|
kai пишет: | Народ!
а кто-нибудь читает %тему ?
Файлы "Справка по интерфейсам системы" и "Справка по сервисам прикладного ядра" кому-нибудь пригодились хоть раз ?
 |
Саша, привет!
А они про что?
Вдруг полезная штука.
Соответственно, ответ - нет, мне ни разу не пригождались  |
|
 |
kai Профи
Вступление в Клуб: 16.08.2012
|
Вт Сен 11, 2012 12:27  Re: 01_Интерфейсы_YY_VER.chm; 02_Сервисы ПЯ_YY_VER.chm |
|
Полезность: Нет оценки
|
Привет, Лёша!
С версии 11.14 (то есть скоро уже как год) вместе с обновлением поставляются 2 файла с описанием всех сервисных и интерфесных библиотек.
Файлы генерятся автоматически по комментариям, находящимся в этих библиотеках.
--
Девиз: Прежде, чем пытаться найти смысл между строк, сначала прочти сами строки. |
|
 |
pas Профи
Вступление в Клуб: 20.11.2007
|
Вт Сен 11, 2012 12:48  Re: 01_Интерфейсы_YY_VER.chm; 02_Сервисы ПЯ_YY_VER.chm |
|
Полезность: Нет оценки
|
kai пишет: | Народ!
а кто-нибудь читает %тему ?
Файлы "Справка по интерфейсам системы" и "Справка по сервисам прикладного ядра" кому-нибудь пригодились хоть раз ?
 |
Интересно однако  |
|
 |
alex_orb Участник со стажем
Вступление в Клуб: 28.09.2007
|
Вт Сен 11, 2012 14:24  Re: 01_Интерфейсы_YY_VER.chm; 02_Сервисы ПЯ_YY_VER.chm |
|
Полезность: Нет оценки
|
kai пишет: |
а кто-нибудь читает %тему ?
Файлы "Справка по интерфейсам системы" и "Справка по сервисам прикладного ядра" кому-нибудь пригодились хоть раз ?
 |
Данные справочные документы, к сожалению, ничего не добавляют к информации уже содержащейся в исходных текстах системы. Абсолютно формальные документы сделанные для галочки. |
|
 |
svn Профи
Вступление в Клуб: 04.02.2008
|
Вт Сен 11, 2012 14:54   |
|
Полезность: Нет оценки
|
мне там расцветочка синтаксиса нравиться - это Администратор так настроили или внешняя приблуда? |
|
 |
lexus Профи
Вступление в Клуб: 28.09.2007
|
Вт Сен 11, 2012 18:27   |
|
Полезность: Нет оценки
|
В Админе расцветку настраивать запросто. Там редактор текста прикольный используется. Правой кнопкой в тексте, Свойства - посмотрите. |
|
 |
kai Профи
Вступление в Клуб: 16.08.2012
|
Вт Сен 11, 2012 19:40  Re: 01_Интерфейсы_YY_VER.chm; 02_Сервисы ПЯ_YY_VER.chm |
|
Полезность: Нет оценки
|
alex_orb пишет: | kai пишет: |
а кто-нибудь читает %тему ?
Файлы "Справка по интерфейсам системы" и "Справка по сервисам прикладного ядра" кому-нибудь пригодились хоть раз ?
 |
Данные справочные документы, к сожалению, ничего не добавляют к информации уже содержащейся в исходных текстах системы. Абсолютно формальные документы сделанные для галочки. |
Содержание - нет, не добавляют. А форма - добавляет. Добавляет возможность посмотреть в другом виде: иерархия и пр. Кстати, ведь любой отчёт - тоже всего лишь та же информация, которая уже есть в БД.
Нам интересна конструктивная критика: что можно/нужно улучшить.
Документация собирается автоматически. Формирование комментариев к интерфейсам регламентируется. Тем самым мы пытаемся научиться создавать документацию на этапе разработки. В природе есть аналоги: JavaDoc, MSDN в части .Net'a описания классов. |
|
 |
Alexsey Эксперт
Вступление в Клуб: 06.09.2007
|
Ср Сен 12, 2012 16:02   |
|
Полезность: Нет оценки
|
svn пишет: | мне там расцветочка синтаксиса нравиться - это Администратор так настроили или внешняя приблуда? |
Можно у того человека кусок реестра попросить с расцветкой синтаксиса? _________________ всегда есть как минимум 2 выхода |
|
 |
kai Профи
Вступление в Клуб: 16.08.2012
|
Пт Сен 14, 2012 06:48  расцветочка синтаксиса в .chm фалах 02_Сервисы ПЯ_12_16.chm |
|
Полезность: Нет оценки
|
Alexsey пишет: | svn пишет: | мне там расцветочка синтаксиса нравиться - это Администратор так настроили или внешняя приблуда? |
Можно у того человека кусок реестра попросить с расцветкой синтаксиса? |
Алексей, это не реестр, это Java-скриптовая раскраска.
Можно разархивировать .chm и найти в нем .js файл. |
|
 |
hornet Участник со стажем
Вступление в Клуб: 24.07.2008
|
Вт Окт 09, 2012 11:51   |
|
Полезность: Нет оценки
|
Александр, добрый день.
По существу вопроса - почему то проще заглянуть именно в словарь и там найти все что нужно - возможно дело привычки.
Ошибочку заметил см. вложенный файл. При нажатии зеленого знака вопроса возникает ошибка.
Про автоматическую генерацию документаций на основе данных из закладки "Комментарии" отказались ? |
|
 |
kai Профи
Вступление в Клуб: 16.08.2012
|
Ср Окт 10, 2012 07:26   |
|
Полезность: Нет оценки
|
Добрый день, Ренат.
При возникновении ошибки если установить признак "Больше не показывать", то она и не будет появляться. Поэтому её ещё не исправили. В общем, пока иконка вопроса на зелёном фоне для красоты.
Автоматической генерации документаций на основе данных из закладки "Комментарии" никогда и не было. Комментарии всегда были доступны пользователю из АРМа "ЦФТ-Навигатор". Но это была пользовательская документация. Сейчас комментарии есть далеко не везде. В большинстве своём они безнадёжно устарели. Но всё равно могут быть актуализированы и использованы при необходимости.
Если говорить о пользовательской документации, то она разрабатывается с помощью "Help and manual", а вызов её из АРМа "ЦФТ-Навигатор" реализован по Ctrl-F1. Причём, если пользователь вызвал операцию и нажал Ctrl-F1, то должна открываться справка именно по этой операции.
Описание об этом нужно искать по фразам: "Контекстная справка" и "Комментирование контекстной справки":
1. Для работы функционала "Контекстная справка" необходимо установить подсистему "Контекстная справка" из хранилища HELP_SYSTEM71.mdb и пр. ... |
|
 |
lexus Профи
Вступление в Клуб: 28.09.2007
|
Ср Окт 10, 2012 08:38   |
|
Полезность: Нет оценки
|
kai пишет: |
Автоматической генерации документаций на основе данных из закладки "Комментарии" никогда и не было. |
Не согласный я. В Админе словаря: Словарь - Системные справочники - Пользовательская документация.
Генерит doc из комментов к операциям из выбранных ТБП |
|
 |
kai Профи
Вступление в Клуб: 16.08.2012
|
Пт Ноя 09, 2012 06:09   |
|
Полезность: Нет оценки
|
lexus пишет: | kai пишет: |
Автоматической генерации документаций на основе данных из закладки "Комментарии" никогда и не было. |
Не согласный я. В Админе словаря: Словарь - Системные справочники - Пользовательская документация.
Генерит doc из комментов к операциям из выбранных ТБП |
Лёша, ты, конечно, молодец, что помнишь эту фичу. Вот только как пользовательская документация результат работы этой кнопки с системой никогда не поставлялся.
Во-1-х, в комментариях нельзя использовать скриншоты.
Во-2-х, от пользовательской документации требуется связанная информация не по одной операции, а по какому-то бизнесс процессу, который может состоять из запуска нескольких операций.
То, что сейчас поставляется как пользовательская документация (в целом) - это как небо и земля с тем, что было с докой по комментам из операций. |
|
 |
|