Вопрос по документированию разработки

[oip]

Готовлюсь сейчас к сертификации по программированию и хочу кое-что прояснить.

Если я создал новую Таблицу/Класс/Форму/Отчет, то где по BP я должен ее документировать? И где об этом прочитать?

a. Application Developer Documentation
b. Application Documentation
c. System Documentation

Спасибо.

[EVGL]

b. Application Documentation

[oip]

Для всех видов объектов один и тот же ответ?
А почему и где об этом напиcано?

[MikeR]

ApplicationDocumentation. Ведь при нажатии F1 информация идет оттуда

[oip]

В принципе да. Тогда объясните плиз назначение Application Developer Documentation? Может там тоже надо что-то описывать? Нет?

[kashperuk]

Ну, хотя бы исходя из названия,
System - для системной доки - ее править нельзя.
Application Doc - для описания работы объекта (именно со стороны пользователя - то есть, как и написал MikeR - то, что увидит пользователь, нажав F1 на незнакомом объекте)
А Application Developers Doc - для разработчиков - там есть только 2 подузла - таблицы и классы - описанные с точки зрения разработчиков

Поэтому в вашем вопросе ответ однозначен

[oip]

Цитата:

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

А Application Developers Doc - для разработчиков - там есть только 2 подузла - таблицы и классы - описанные с точки зрения разработчиков

Вот именно! Не должен ли я тут тоже описывать в обязательном порядке?

PS Сорри, если ввел в заблуждение: это на самом деле не один вопрос, а 4 - для каждого объекта свой вопрос. Т.е. может быть, что таблицы и классы - ответа а и б, а для форм и репортов - только б.

[MironovI]

Хорошо, тогда вот такой вопрос, таблица AccentFactorEconomical описана как в Application Developer Documentation таки в Application Documentation, это как, разная справка для разработчиков и пользователей? кто и как будет какую получать? т.е. как пользователь получит справку по таблице через интерфейс Аксапты?

ACODDOC://Tables/AccentFactorEconomical
APPLDOC://Tables/AccentFactorEconomical

[MikeR]

На первый взгляд тут идет разделение. Если в AD это список всех полей причем и системных с описанием, то в ADD это уже список методов.

[MironovI]

Вобщем я так понял, что разработчик должен описать в ADD - а конс - AD - и все, в system не суемся..

[oip]

Вопрос-то про разработчика. Консультант вообще ИМХО ничего и нигде описывать не должен. Ему АОТ недоступен.

[MikeR]

Oip а так не подходит? Поля описываем в AD а методы в ADD

[oip]

Я не знаю как подходит. Это я и хочу выяснить.
Вопрос свормулирован так:
Где размещать информацию о новом отчете?
Если вы создали новую таблицу, то где вы должны её описать?
И.т.д.
+ вышеприведенные варианты ответов.

Мне хотелось бы:
а) Понять, как надо на тесте отвечать.
б) Самому разобраться, как правильно и почему.

[kashperuk]

А вы видели в системе хоть один объект, где в документации разработчика отображалось бы больше того, чем сгенерированно автоматически??
Я не нашел таких (хотя, может быть, плохо искал)

Поэтому я думаю, ответ именно в пользовательской документации. И править нужно именно ее.

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

Цитата:

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

Готовлюсь сейчас к сертификации по программированию и хочу кое-что прояснить.

Если я создал новую Таблицу/Класс/Форму/Отчет, то где по BP я должен ее документировать? И где об этом прочитать?

a. Application Developer Documentation
b. Application Documentation
c. System Documentation

Спасибо.

На самом деле, знать это совершенно не обязательно! Просто встаете в AOT на созданный объект и тупо жмете F1. Далее кнопка "Редактировать" - и вперед. AXAPTA сама разберется куда и что вставить.

Если просто ради интереса, то после написания HELP откройте форму SysHelpOtherview и на каждой закладке отфильтруйте записи из слоя USR (первый столбец в каждом Grid)

Окажется, что вообще ВСЯ информация введенная таким образом будет только и исключительно на закладке "Приложение". Т.е. это узел Application Documentation

[oip]

Цитата:

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

Если просто ради интереса, то после написания HELP откройте форму SysHelpOtherview и на каждой закладке отфильтруйте записи из слоя USR (первый столбец в каждом Grid)

Не столько ради интереса, сколько для того, чтобы при сдаче теста правильно ответить.

Таким образом, резюме:

1) При создании любого объекта в АОТ (будь то таблица, класс, отчет и.т.д.) разаботчик должен добавить описание только в Application Documentation.
2) При этом, при желании, разработчик так же может добавить описание методов таблиц и классов в Application Developer Documentation, но это не обязательно.

Все верно?
Т.е. на все 4 вопроса в тесте ответ один и тот-же, b? Странно конечно, зачем тогда столько разных вопросов? Просто, чтобы запутать?

[kashperuk]

Похоже на правду.

Вопрос то попадается всего один из 4ех (в очень редком случае могут попасться 2 подряд) Поэтому - это просто вопросы, они ж тоже люди, им сложно много вопросов придумать разных

[oip]

Ну вот, сегодня сдавал экзамен. Попались два вопроса. Так что разрешите все же поделится правильными по-моему мнению ответами:

Где надо описывать новые таблицы и классы.
- Application Developer documentation
- Application documentation
- System documentation

Где надо описывать новые отчеты:
- Application Developer documentation
- Application documentation
- System documentation

[MikeR]

Oip поздравляю.
Теперь у вас есть ценный документ

[oip]

Спасибо.