Proposed outline for ontology documentation, circa 2011

Dates from 2011

The following page is to be used as a workspace for the Ontology Team to create an outline of needed Ontology user documentation. VIVOONT-69 describes a need for documentation in 2 main areas (1) data entry by users, and (2) Ontology Editing by the designated ontology editor. This page does not include the Ontology class and property definitions or examples. Those will be stored directly within the ontology itself, and a method will be created for "printing" those out for use in this written documentation.

The actual documentation should not be written here. This page is simply for the outline.

This work is being done in conjunction with the Documentation Team, and the liaison to that team is Kerry Britt. Kerry provided an initial master table of contents which I've modified for our purposes. This modified table of contents is intended only to be a starting point for discussion and work among the ontology team. So, please feel free to change and modify the table of contents below as needed.

A VIVO Glossary is already under development, and it includes a number of Ontology related terms. That Glossary can be found here: VIVO Glossary

If you are interested in writing any section, I believe the documentation team will welcome any help. Select the section you are interested in writing, make a note on the page, and then work with Kerry and the documentation team to get it completed.

Once again though, please do not write it here. This page is intended only for the outline.

(1) data entry by users

• Overview
• Navigating the Interface
• Add individual to VIVO

• Adding People
  Utilize this info: http_//vivoweb.org/support/user-guide/add-new-people http_//vivoweb.org/support/user-guide/add-new-people

• Adding a New Image
  Utilize this info: http://vivoweb.org/support/user-guide/add-new-image

• Adding Courses
• Adding Activity
• Adding Topics
• Adding Events
• Adding Organizations
• Adding Equipment
• Adding Publications
  Utilize this info: http__//vivoweb.org/support/user-guide/add-new-publications http__//vivoweb.org/support/user-guide/add-new-publications
• Adding Locations

• Custom forms
• Example Content
• Appendix A - Trouble Shooting
• Appendix B - FAQs
• Appendix C - Helpful Resources
• Appendix D - Glossary
  Utilize info from here: VIVO Glossary
• Appendix E - Ontology classes and properties definitions and examples.

(2) Ontology Editing by the designated ontology editor

• Overview of Ontology Editor Functions
• VIVO Software Ontology Management
• Ontology List

1. Add New Ontology

• Ontology Name
• Namespace URI
• Namespace Prefix
  *Class Management
  1. Class Hierarchy
• Stuff here...
  2. Class groups
• Stuff here...
• Property Management

1. Object Property Hierarchy
   • Stuff here...
2. Data Property Hierarchy
   • Stuff here...
3. Property Groups
   • Stuff here...

• Verbose Property Display
• VIVO Ontology Best Practices
• Ontology Design Principles for VIVO
  Use info here: Practical Ontology Design Principles in the VIVO context
  Also here: Ontology Design Choices
  Also include: Info on policy of no multiple inheritance in VIVO. Accepted through VIVOONT-1 JIRA issue.
• Local Modifications and Local Ontologies
  Use the info from here: The core ontology and its annotations will include guidance for creating local extensions to core.
• Data Migration Principles
• Controlled Vocabularies in VIVO

1. What is it?
2. When are you really developing your own?
3. Tips in managing controlled vocabularies
4. Utilizing subject vocabularies within VIVO

• Ontology Change Management Process
• Appendix A - Trouble Shooting
• Appendix B - FAQs
• Appendix C - Helpful Resources
• Appendix D - Glossary
  Utilize info from here: VIVO Glossary
• Appendix E - Ontology classes and properties definitions and examples.