Question
Which tool should I use for creating/publishing documentation?
Solution
The University of Oregon offers a couple of documentation tools. Use the following information to help you determine which tool would be best suited for your documentation.
- Confluence should be used...
- for internal technical/developer documentation,
- if documents need to be restricted by groups or the public, and/or
- documentation not intended for the general end-users (e.g., faculty, staff, or students).
- The UO Service Portal should be used...
- for customer-facing documentation (e.g., faculty, staff, or students), and/or
- for documentation that can be public/unrestricted
- When creating documentation for the Service Portal, consider that documentation kept here will be indexed by Google.
- SharePoint can also be used....
- for department files internal to your employees,
- for collaboration with external, non-university colleagues (e.g., fellow researchers, faculty, staff, etc.),
- if files and folders need to be checked out from a document library, and/or
- documentation not intended for your customers (e.g., faculty, staff, or students).
Resources
To ensure that your documentation meets our style guide and accessibility standards, please refer to the Knowledge Base Style Guide category of articles. The guidelines are employed by both Confluence and the UO Service Portal and can be adapted for SharePoint. Additionally, you can refer to the Guidelines from the Digital Accessibility @ UO website.
Additional assistance
Submit a ticket to the Knowledge Management Support service page for any additional questions.