Difference between revisions of "ESciDoc Technical Documentation/Wish List"
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...) |
m |
||
(8 intermediate revisions by 3 users not shown) | |||
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 | ||
* workflows in general (pending->submitted->released ... state changes allowed) | |||
* authorization process | |||
* authentication process | |||
* PubMan start-up in more details (installation, pre-requisite objects, use of Admin) | |||
* Best Practice for implementing new services | |||
* Best Practice for presentation implementation | |||
=Structure proposal= | =Structure proposal= | ||
*Colab? | *Colab? | ||
*EA? | *EA? | ||
[[Category:eSciDoc|Technical Documentation]] |
Latest revision as of 13:30, 5 January 2011
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
- workflows in general (pending->submitted->released ... state changes allowed)
- authorization process
- authentication process
- PubMan start-up in more details (installation, pre-requisite objects, use of Admin)
- Best Practice for implementing new services
- Best Practice for presentation implementation
Structure proposal[edit]
- Colab?
- EA?