The purpose of this document is to provide a standard format for staff writing or editing FOLIO instructions (steps/outcomes/images). Find our Confluence FOLIO page at: https://confluence.cornell.edu/display/ltstr/FOLIO .
See Emma’s page as a good sample in formatting: https://confluence.cornell.edu/display/ltstr/Access+status+types%3A+how+to+create%2C+edit%2C+delete%2C+assign%2C+unassign%2C+and+filter+by+access+status+types
- Add Preconditions or other notes first. Link precondition to other instructions if helpful. Link function found under the ‘+ Insert more content’ icon.
- Use ‘Insert Table’ icon to create a 2-column table.
- Add numbered (or bulleted?) steps to the left column. Add expected results at the end of the section after the steps to which it applies.
- Add images to the right column using the ‘Insert files and images’ or <Ctl + M>
- Break table into smaller sections if necessary and add captions at the beginning of each. Premade captions are available under the ‘Paragraph’ icon in upper left.
- Colored arrows or circles highlight important points. Unfortunately, it can’t be done in Confluence and has to be done in some editing program outside of Confluence, such as Paint
- Highlight text for special warnings, such as: NOTE: at this time (Honeysuckle) you CANNOT DELETE a tag once you've created it, so be careful! This can be done in Confluence.
- For readability to the user, add ‘Horizontal rule’ between sections. It is found under the ‘+ Insert more content’ icon
- If lengthy, add a ‘Table of Contents’. It is found under the ‘+ Insert more content’ icon. See example at: https://confluence.cornell.edu/display/ltstr/Contacts%3A+how+to+add%2C+assign%2C+edit%2C+unassign+and+delete+contacts
- Add tags as follows: Tags are actually called labels in Confluence. If you have a page open for editing, at the very top, by the page’s title, there will be a tiny label icon (it looks just like the tag icon in FOLIO). Click on it, enter your label into the Add box, click ‘Add’, then Close. The label will appear in the bottom right-hand corner of the page, and if you click on it, you can view a list of all the pages with that label. The goal is to tag any page useful to your team with a label, so the Organizations pages might be tagged with “acq” as well as “erm.”