Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.1%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: JOR-Donegal
  • Default Branch: main
  • Size: 0 Bytes
Statistics
  • Stars: 0
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created 9 months ago · Last pushed 9 months ago
Metadata Files
Readme Citation

README.md


description: How to write academic documents

Introduction to Academic Documentation

You will always face an issue of divergence between academics. I can submit a paper to one conference and be refused, and win a best paper award, with the same unedited content, at a different conference. The key starting point is to identify the requirements of the referees or you supervisor/grader.

In designing the assessment strategy for some modules, I use practical exercises and reports to introduce academic writing.

When you are doing laboratory work you will be required to keep records of you work in a formal manner. There are several reasons for this.

  1. This is normal practice in Science and Engineering academic disciplines.
  2. It is a normal process carried out by working consultants, administrators and systems engineers and it is a practice which needs to become second nature to you.
  3. This is a record of the work you have done and as such provides the basis for your CA marking, to both your lecturer and the external examiner.
  4. We need to begin developing your skills in academic writing. The style you use here should be compatible with conference and journal papers.
  5. Some of the laboratory work you are doing will be of use to you in employment.
  6. Many of us keep our own work logs/method sections in cloud storage, as invaluable reference information. You may find your own lab books of use to you in your career. These documents are intended to provide some guidelines as to how to write a lab report, the fields of data required and the sort of content which should exist in each field.
  7. In commercial scientific work, if I am submitting a tender, I may have to include a methods section.

In every case, the report should be written in academic language, with the body of text in the third person, past tense. Your writing should be concise, never use more words than you need to express what you want to say. You may use screenshots, but only where they communicate more meaning than you could do economically in words.

All work must be entirely your own. Where you work collaboratively with another student or any third party (other than your lecturer) you must acknowledge the contribution in your conclusion. You should not at any stage, copy and paste from any source, even one you have referenced. Your list of references (if any) will normally appear at the end of the lab report. If you use a Large Language Model (LLM) for research, the same rules apply. You must include the output from the LLM in an appendix.

See section 5.7 of the Institutes’ Quality Manual (available through the main web site) for clarification as to what constitutes plagiarism.

To begin a laboratory report, use the template provided in the course materials.

When describing physical properties, only use SI units. In a real world project based in the US or UK, there may be exceptions to this. For all work on my modules, use SI units only.

\

Owner

  • Name: John ORaw
  • Login: JOR-Donegal
  • Kind: user

Citation (citations.md)

---
description: How to reference sources in your academic documents
---

# Citations

It is important to get your citation style right and most students will become familiar with basic referencing software during the course to their program of study. In the past, I have used **Zotero** and **Endnote**, depending on the University or research group I was doing work with. **Citavi** is also very good. Check the library section of the University website to see what type of software you should use and to get some basic instruction.

Faculties normally have a consistent bibliographic referencing standard and again, check the library section of the Institute website to get our current guidelines.

Harvard Referencing is an Institute standard but is a bit clunky for reports/papers.

If I am writing papers for IEEE or ACM conferences or journals, I use a more economical style. A number \[X] is inserted at the point in the document where I am citing another author's work. At the end of the paper, the full reference \[X] of the work is provided.

Do a quick Internet search on IEEE referencing.

For laboratory reports in this module, use the IEEE style.

GitHub Events

Total
  • Push event: 1
  • Create event: 1
Last Year
  • Push event: 1
  • Create event: 1