사람이 읽을 수있는 형식으로 트리 - 트리 변환을 문서화하려면 어떻게합니까?

Question

웹 서비스 집합에 대한 외관 역할을하는 응용 프로그램을 문서화해야합니다. 응용 프로그램은 SOAP 요청을 받아들이고 이러한 요청을 기본 웹 서비스에서 이해할 수있는 형식으로 변환합니다. 이러한 서비스에는 각각 고유 한 인터페이스가있는 서비스가 몇 가지 있습니다. 일부는 SOAP, 일부 HTTP POST, 정중 한 사회에서 언급되지 않은 다른 형식을 허용합니다.

SOAP 호출의 필드와 다른 형식의 필드를 매핑하는 방법을 문서화해야합니다. 모든 사람들이 "XSLT"를 울기 전에 필자는 그 표기법이 인간 친화적이어야 함을 언급해야한다. 이상적으로는 Excel-able이 될 수 있습니다.

이전에 이런 종류의 문제가 발생 했습니까? 어떻게 그걸 해결 했니? 스프레드 시트에 적합한 트리 - 트리 변환을위한 친숙한 표기법이 있습니까?

Answer 1

나는 이것을해야만했다. 내가 한 방식은 계층 적 구조에 따라 글쓰기를 시작하는 것입니다.

결국 나는 자신을 반복하고 있음을 알게되었습니다. 예를 들어, 특정 요소에는 공통 속성 집합이 있습니다. 특정 구성 요소에 대한 섹션 앞에 해당 공통 설정에 대한 설명서를 제공합니다. 특정 simpleTypes 처리에 대한 문서화 작업과 동일합니다.

결국 전체적인 흐름과 변환의 "철학"에 대한 고차원의 토론이있었습니다. 그러나 나는 그것을 조금씩 조금씩 반복하여 지루해 지도록 고쳐 주었다.

그건 그렇고, 나는 기술 분야의 작가가 아니라 개발자 다.

Answer 2

나는 지금까지 아무 것도 발견하지 못했지만 Java에서 한 유형의 객체를 다른 유형으로 변환하는 데 도움이되는 많은 라이브러리에 대한 포인터를 발견했습니다. 참고로, 나는 모든 자바 빈즈 변환에 자바 빈즈 어떤 종류의 일을, 여기에 가장 유망한 사람을 나열하고 있습니다 :

• Transmorph
• EZMorph
• Dozer