Difference between revisions of "ESciDoc Technical Documentation/Wish List"

From MPDLMediaWiki
Jump to navigation Jump to search
m (New page: =Content proposal= * Service description in Colab, linked to Test instance of a service (test/demo servers) * Component diagrams for services and their dependencies * Sequence (esp. for da...)
 
Line 1: Line 1:
=Content proposal=
=Content proposal=
* JavaDoc
* Service description in Colab, linked to Test instance of a service (test/demo servers)
* Service description in Colab, linked to Test instance of a service (test/demo servers)
* Component diagrams for services and their dependencies
* Component diagrams for services and their dependencies
* Sequence (esp. for data flows) or communication diagrams for service compositions
* Sequence (esp. for data flows) or communication diagrams for service compositions
* HowTo for developers and development environment, deployment etc.
* HowTo for developers and development environment, deployment etc.
* Links to documentation of core services should be prominently placed  
* Links to documentation of core services should be prominently placed


=Structure proposal=
=Structure proposal=
*Colab?
*Colab?
*EA?
*EA?

Revision as of 08:08, 22 August 2008

Content proposal[edit]

  • JavaDoc
  • Service description in Colab, linked to Test instance of a service (test/demo servers)
  • Component diagrams for services and their dependencies
  • Sequence (esp. for data flows) or communication diagrams for service compositions
  • HowTo for developers and development environment, deployment etc.
  • Links to documentation of core services should be prominently placed

Structure proposal[edit]

  • Colab?
  • EA?