S7-Writing Quotes
#all #documentation #standard
1 Purpose
The purpose of this document is to formalize the format of Quotes in the Team Notebook.
2 Scope
All team members
3 Standard information
3.1 Link to or otherwise cite the source
Authors shall start Quote docuements with a "Location" section where:
- Authors shall provide links to the source work where available.
- Where source links are unavailable: authors shall provide a description of how to obtain the material.
3.2 Describe the material
- Authors shall include a "Description" section imediatley following the Location section.
3.3 Tagging
At a minimum:
- Authors shall tag Quotes with the type or format of the content: "video", "pdf", "website", etc.
- Autnors shall tag Quoate with tags relating to the Departments they expect to find the information useful.