Форум Сообщества Аналитиков

Общий раздел => Для всех => Тема начата: Alex_Gas от 11 Мая 2012, 15:09:43

Название: Документирование XML структур
Отправлено: Alex_Gas от 11 Мая 2012, 15:09:43
Добрый день!

Хотел обсудить вопрос описания XML данных в документе ТЗ.

Есть ли у кого-нибудь практический опыт / ссылки на "best practices" - как в документе для широкого круга читателей, таком как ТЗ, в простом и понятном виде описать элементы и атрибуты XML-структуры, при этом отразить вложенность элементов, принадлежность атрибутов конкретному элементу?

Не хочется "изобретать велосипед", если есть какие-нибудь стандартные нотации / шаблоны.
Название: Re: Документирование XML структур
Отправлено: Thyestes от 11 Мая 2012, 16:12:23
Добрый день.

Изобретать велосипед не надо, но мало ли Вы что-то грандиозное и эффективное придумаете.
Теперь желательно уточнить цели:
- Вам надо описать структуру XML документа? Или что?
 Прошу уточнить что значит "описания XML данных"

Например, есть следующие описания
- Технические требования к взаимодействию информационных систем в единой системе межведомственного электронного взаимодействия - сам приказ  (http://minsvyaz.ru/ru/doc/?id_4=368)
- Или Требования к методу передачи данных на яндексе (http://partner.market.yandex.ru/legal/tt/)

И еще. Вы в ТЗ хотите закрепить структуру XML? А если что-то измениться. Все по ТЗ систему не сдать?

Почему не написать что-то вроде
При разработке дополнительных адаптеров, внешний поставщик должен соблюдать следующие условия:
- использование XML в качестве описания форматов передаваемых данных (http://www.w3.org/TR/2008/REC-xml-c14n11-20080502/)

Как урезанный пример -  во вложении - описание в виде таблички.
Название: Re: Документирование XML структур
Отправлено: Alex_Gas от 11 Мая 2012, 16:55:18
Thyestes, Ваш пример в прикрепленном файле - как раз то что мне нужно: то есть описание элементов определённого XML-документа. Спасибо! Буду ориентироваться на него как на возможный вариант.

А не подскажете, данный табличный формат описания где-то утверждён? Является каким-либо стандартом?
Такой же вопрос по графической нотации в примере - иногда встречаю её в документах, но не нашел - есть ли у неё название и кто её разрабатывает: w3c или кто-то ещё?
Название: Re: Документирование XML структур
Отправлено: Galogen от 11 Мая 2012, 17:11:51
Такой же вопрос по графической нотации в примере - иногда встречаю её в документах, но не нашел - есть ли у неё название и кто её разрабатывает: w3c или кто-то ещё?
Вообще это XML Scheme (http://ru.wikipedia.org/wiki/XML_Schema)
Название: Re: Документирование XML структур
Отправлено: Alex_Gas от 11 Мая 2012, 17:32:28
Вообще это XML Scheme (http://ru.wikipedia.org/wiki/XML_Schema)
Вопрос был именно по ГРАФИЧЕСКОЙ нотации для XSD. Нет ли ссылки, где она определена? Спасибо.
Название: Re: Документирование XML структур
Отправлено: Thyestes от 12 Мая 2012, 12:05:57
По поводу табличного формата описания -  обычно утверждается на уровне министерства.
Например, УТВЕРЖДЕН приказом Роснедвижимости от 28 октября 2008 г. № П/0389

По поводу графической нотации, на счет именно утверждения не могу подсказать, но поищите, например, продукт Altova XMLSpy или другие (http://www.w3.org/XML/Schema)