watonomous.github.io

1. Knowledge Base
2. Knowledge Base Home
3. Platform Onboarding

[ Knowledge Base : Confluence User Guide ]

Created by [ Rowan Dempster], last modified on Dec 29, 2019

Basic Info

WATonomous uses Confluence to hold our Knowledge. Some examples of Knowledge are:

• Platform user guides (what you are reading now)
• How our software algorithms work
• Notes from our Division Management meetings

Access

The account that you are viewing this document using (your Confluence account) is the same account that you will always access Confluence using! Simply navigate to https://confluence.watonomous.ca and login!

If you forgot how you logged in to view this document, remember that you login credentials (username and initial password) were sent to you in your acceptance and onboarding email.

Getting started documentation

Here are some good Confluence Starter Guides:

• Confluence Server documentation: https://confluence.atlassian.com/doc/confluence-server-documentation-135922.html
• Full tree of all Confluence User Guides: https://confluence.atlassian.com/display/CONF55/Confluence+User%27s+Guide

Also start by exploring the existing spaces and pages! Read through the whole Knowledge Base, as well as your Division's Space, and your Groups folder, etc...

Historical Context

Before Winter 2020, WATonomous used Phabricator Wiki to hold our knowledge: https://phabricator.watonomous.ca/w/

In Winter 2020, we switched to the industry standard JIRA & Confluence tools. As part of this, all (non-deprecated) pages in the Phab Wiki were copied over to Confluence. The old Phabricator Wiki will be kept running (but not used) for 12 months, then abandoned. 

This document is being written at the start of W20, and so since Confluence has not been used yet, there is not much I can say in the User Guide. However, as we start using Confluence in W20 and onwards, this guide will be updated with things we learn about how to use Confluence.

Usage Guidelines

• Anyone can edit, delete, or create a new Phab document. But please check with the owner of the document/folder you are editing before doing so!
• I have never seen a case of over-documenting on WATO, but have very commonly seen cases on under-documentation. When in doubt, document everything!
• You can learn a lot about how to write technical documentation by reading what is already on the Wiki.
  My personal approach: I imagine the reader of the document as someone who has just joined WATO, and ask myself, how can I write the document such that the newbie can understand what is being said? And when the explanations would get off track of the topic of the document, what links to other documentation can I provide for further reading?

This also looks like a good guide for how to write technical documentation: https://www.writethedocs.org/guide/

\

Comments:

+———————————————————————–+ | [] | | | | I have actually seen over documentation. It becomes a problem when | | information is duplicated, unsynchronized, and contain recursive | | links to other documents everywhere. | | | | {.smallfont align=”left” style=”color: #666666; width: 98%; margi | | n-bottom: 10px;”} | | | | Posted by henry.wang at Jan 04, 2020 08:14 | | | +———————————————————————–+

Document generated by Confluence on Nov 19, 2021 12:21

Atlassian