## page was renamed from 2009Tasks/DocumentationAnalysisDocument /!\ '''Deprecated''' See [[Tasks/7]] ------------------------------------- ##Analysis Documentation ## Headline such as "Analysis of Backup Requirements" = Analysis of Documentation = ## Add detailed explanation/analysis of the task. ## Datamodel dokumentation; Webservice; Design-dok; Drift-dok; Install-guide; open source We need to release the documentation, for Open Sourcing purposing * 7.1 Setup wiki (estimate 3 md) We need to write the following documents: * 7.2 Datamodel documentation - needs to be extracted and published. Possibly incorporate documentation written by task FRBR. (estimate 2 md) * 7.3 Webservice documentation - for all public APIs - most are already written, but should be extracted and published, and checked to be up to date (esp. ECM-webservices). Documentation should be written in task API. (estimate 2 md) * 7.4 High level design documentation for the final DOMS, that is the DOMS created by Milestone 2009-1. Includes documentation written in the task Fedora 3.2 setup, and possibly more. (estimate 6 md) * 7.5 Maintenance and monitoring documentation - generated by the task Maintenance Agreement. (estimate 1 md) * 7.6 Install guide - generated by the task Maintenance Agreement. (estimate 1 md) * 7.7 Licensing documents etc. for open source. Includes license for this software, and dependencies. (estimate 4 md) Estimate total: 19 md ## This may include use-case diagrams etc. attached like this: ## Link to original: [http://merkur/svn/doms/trunk/MODULE/docs/MyUseCase.dia] ## png on the wiki page: http://merkur/svn/doms/trunk/MODULE/docs/MyUseCase.png == Prerequisites and Assumptions == Dependencies on other tasks, as described above: * Documentation from task FRBR. * Documentation from task API. * Documentation from task Maintenance agreement. * Documentation from task Fedora 3.2 ## Describe any prerequisites and assumptions that are important for this analysis, e.g.: ## What can we rely on? ## Which assumptions must hold in order to solve the problem described in this document? ## Risks and Stakeholders are of course important to the analysis, but we have dedicated pages for these, and they should only be included here if this task poses additional risks or new problems... == Resources == ## List links to documents, wiki pages etc. that are relevant to this analysis. ## * [:LinkToMyRessource:Use case diagram xx] ## * [:LinkToMyVersionControlledDocument:Link to document on user studies e.g. stored in SVN]