Technical Documentation Management - Web Services Design: how to manage interfaces and their methods list -


we developing set of soa application. current stage needs clarify interfaces,, methods list, , methods parameters. have microsoft word document. example, name of chapter 4 "interfaces". each sub-chapter represents interfaces. paragraphs data types , methods:

4.1 imycustominterface 4.1.1. data types 4.1.2. methods 4.2 ianothoerinterface 4.2.1. data types 4.2.2. authorisation methods 4.2.3. salary methods 4.2.4. report methods

current approach works well, don't think best possible solution.

could please advise other possible options technical documentation management?

any thoughts welcome.

thanks lot!

p.s. great if know free tool.

i document web service designs creating shell implementation includes method , parameter definitions. use documentation generator called techwriter web services generate documentation.

this approach makes easy go through several iterations of design since regenerating doc easy, , have head start on actual implementation.


Comments

Popular posts from this blog

asp.net - repeatedly call AddImageUrl(url) to assemble pdf document -

java - Android recognize cell phone with keyboard or not? -

iphone - How would you achieve a LED Scrolling effect? -