ESciDoc Technical Documentation/Wish List
Jump to navigation
Jump to search
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?