Confluence Standards

Each space needs to have an ‘Overview’ where you introduce the space/project to the reader.

The Overview needs to be aimed to the general public. People of various backgrounds and the general public should be able to understand what this space is about.

Include a map of the space in the Overview page to facilitate navigation.

Organize the space from general to specific, simple to complex to keep a good flow throughout.

Create as many sections and subsections as necessary in your space to make it easy to navigate to the section of interest by using the left side bar.

Include pictures, screenshots and diagrams with the corresponding description.

When describing how to set up a hardware component keep in mind that anyone reading your document should be able to replicate your work from scratch.

For projects with several components have a main page were you list all of them and include links to the products when possible. This should be an imbedded google spreadsheet which lives in the project share drive.

Always have someone else read your page and replicate your steps when possible.

Use the shortcuts to link to repositories or live apps when possible

Don’t expose secrets (api keys, github tokens, personal information, etc) in public confluence spaces.

Try to be as descriptive as possible about how to get the local environment setup.

Document any stumbling blocks you had in the development process to help future team members.

Add links to any helpful documents you used in the process of getting things working (stack overflow, tool specific docs, etc).