References and citations are used to attribute external sources, provide credit for content, and offer additional reading or resources. Properly citing sources enhances the credibility of documentation and provides users with the opportunity to explore topics in greater depth.
When to Use References:
- Cite external sources when using third-party content: Always cite external sources when directly quoting, paraphrasing, or using data from other authors or organisations. Example: “According to the World Health Organization,…”
- Use references to support claims or provide additional context: References can back up statements, clarify technical concepts, or offer further reading. Example: “This approach is supported by recent findings in the field (Smith et al., 2023).”
Formatting Citations:
- Follow a consistent citation style: Choose a citation style (e.g., APA, MLA, or Chicago) that aligns with organisational standards and use it consistently throughout the document. Example (APA): “Smith, J. (2023). Introduction to Cybersecurity. Oxford University Press.”
- Include sufficient details for locating the source: Provide all necessary information to enable users to locate the original source, such as the author, title, publication date, and URL. Example: “National Institute of Standards and Technology (NIST). (2021). Framework for Improving Critical Infrastructure Cybersecurity.”
Creating a References Section:
- Include a dedicated references section for citations: At the end of the document, include a section titled “References” or “Bibliography” that lists all cited sources in alphabetical order. Example:
- Smith, J. (2023). Introduction to Cybersecurity. Oxford University Press.
- World Health Organization. (2022). Health and Safety Guidelines.
Linking to References:
- Link to sources directly where appropriate: Provide hyperlinks to online sources to make them easily accessible to readers. Ensure that links are up-to-date and functional. Example: “For more details, refer to the official documentation.”
Dos:
- Use references to support data and claims: Example: “The latest study shows a significant increase in adoption rates (Jones, 2022).”
- Follow a consistent citation style throughout: Example: “National Institute of Standards and Technology (NIST). (2021). Framework for Improving Critical Infrastructure Cybersecurity.”
Don’ts:
- Don’t omit necessary details from citations: Always include sufficient information for locating the source.
- Avoid broken or outdated links in citations: Regularly check and update references.