| |
|
RSS Feed - WebSphere MQ Support
|
RSS Feed - Message Broker Support
|
  |
|
| Any other options to generate message flow documentation ? |
« View previous topic :: View next topic » |
| Author |
Message
|
| ruimadaleno |
 Posted: Wed Mar 04, 2015 7:07 am Post subject: Any other options to generate message flow documentation ? |
 |
|
Master
Joined: 08 May 2014
Posts: 274
|
Hi all,
the project is running, our providers (external teams) are building a lot of services and deploying in message broker. Each one of the services has a WSDL associated.
Now we want to document this services (before the knowledge - external teams is out of house) and we are looking for some help on documentation generation.
I've tried the "Generate documentation" available in Toolkit, but this gives me a rather "complex" pdf document , including ESQL source code.
our goal is to generate less technical and more functional documentation, so that future consumers of these services can understand:
1) What are the business functions provided by the service ?
2) what are the input parameters for each operation, rules associated with parametes usage, parameter description, etc ?
3) what are the output parameters for each operation, rules associated with parametes usage, parameter description,etc ?
we understand we cannot generate this knowledge auto-magically from code. We want to help development teams, generating a document (maybe a docx file) for each service , listing for all operations, all input and output parameters. This document is them completed with the knowledge from development teams
so, i'd like to ear from you experience: do you generate documentation for your message flows projects ? how ? manually ? do you use a tool to generate ?
Note: our teams are using WMB + Toolkit 8.0.0.4 running on windows
_________________
Best regards
Rui Madaleno |
|
| Back to top |
|
 |
| ganesh |
| Posted: Wed Mar 04, 2015 9:50 am Post subject: |
|
|
Master
Joined: 18 Jul 2010
Posts: 294
|
| All what you have asked cannot be generated automatically instead you can create a design document or a interface document by yourself. |
|
| Back to top |
|
|
| ruimadaleno |
| Posted: Thu Mar 05, 2015 2:03 am Post subject: |
|
|
Master
Joined: 08 May 2014
Posts: 274
|
Hi ganesh, thank you for you reply.
I understand it is impossible to fully generate this documentation. I want to help our development teams. The goal is to generate an "empty"/"template" document. This document holds the list of input parameters and output parameters for each operation of the service.
After this document is generated, the dev team completes the document with the knowledege they have about the service.
_________________
Best regards
Rui Madaleno |
|
| Back to top |
|
|
| ganesh |
| Posted: Thu Mar 05, 2015 9:31 am Post subject: |
|
|
Master
Joined: 18 Jul 2010
Posts: 294
|
| There would be some samples available online or the organization for which you are working might already have some documents from earlier project. Searching using a search engine for- "high level design document template" returned few samples for me. |
|
| Back to top |
|
|
|
|
|
| |
|
Page 1 of 1 |
|
You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot vote in polls in this forum
|
|
|
|
