Documentation outline

Documentation outline

Programmer's Guide

• overview
  • What is ODCleanStore (purpose)
  • architecture, architecture features, requirements
  • Components overview
  • Data processing overview
• Used technologies
  • Java, platform (in)dependence
  • RDF, Virtuoso, relational database
  • references to other sources - used formats (RDF/XML, TriG) etc.
  • Maven
  • libraries - Jena, ...
  • Wicket
  • webserver
• Setting up development environment
  • repository
  • project structure
  • build
• Webservices & Interfaces
• Engine
• Transformers
  • Custom Transformers
  • Quality Assessment
  • Data Normalization
  • Object Identification
  • Other Transformers
• Query Execution
• Conflict Resolution
• Administration frontend
• (Conclusion, evaluation)
• (Related work)
• Future Work
• References
• Appendix A: License
• Appendix B: ODCS ontology
• Appendix C: Relational database schema
• (Appendix D: "chronologicky popis prubehu praci na projektu")
• (Appendix E: The Team)

Notes:

• for each component, we should describe
  • purpose
  • basic design
  • classes & interfaces
  • input & output, context
  • error handling
  • all configuration options
• provide diagrams
• mention things like localization, ...

User Manual

• Introduction
  • What is ODCleanStore (purpose)
  • Context
  • Overview (of features)
  • Example use case, mention expected deployment (public contracts, students)
• User roles
  • User creation
• Administration frontend overview
• User accounts administration
• Transformer management
• Pipeline management
• Transformer policies (QA, DN, OI)
• Ontology management
• Other settings
  • QE & CR
  • Prefix management
• Web services overview
• Data publisher
• Data consumer
• Glossary
• References

Notes:

• screenshots

Administrator's & Installation Manual

• System requirements (including performance recommendations, connectivity)
• CD Contents
• Step by step installation guide
• (Contents of the deployed application)
• Configuration Options
• Custom transformers
• (Troubleshooting)

JavaDoc

Notes:

• customized index page and pages for individual packages

[Dušan Rychnovský]

Součásti odevzdávaného projektu

• Jmenný seznam řešitelů a rozdělení jejich práce
• Vývojovou dokumentaci
• Uživatelskou dokumentaci
• Specifikaci hostitelské platformy (hardware, operační systém, případný další software apod.)
• Vlastní instalovatelné softwarové dílo
• Všechny zdrojové texty, soubory a jiné prostředky, ze kterých dílo vzniklo

---

Součástí vývojové dokumentace by mělo mimo jiné být:

• Stručné uvedení do problematiky, kterou projekt řeší
• Zasazení vytvořeného díla do kontextu existujících programových děl řešících obdobnou problematiku
• chronologický popis průběhu prací na projektu
• kritické zhodnocení přijatých řešení a možnosti dalšího vývoje

---

Uživatelská dokumentace musí obsahovat zejména:

• Podrobný popis instalace díla včetně přesné specifikace požadavků na použitý hardware a software
• Popis všech funkcí díla
• Způsob ovládání díla