> For the complete documentation index, see [llms.txt](https://johnoraw.gitbook.io/gettingstarted/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://johnoraw.gitbook.io/gettingstarted/guidance-on-writing.md). # Guidance on writing One of the biggest challenges in the world of academia is to get your writing style just right. At the start you may be frustrated by doing good technical work but not getting the marks for it. I can’t fix that problem in this document! What I can do is give you some simple guidance which will hopefully help you to start. It’s unrealistic to hope to be doing perfect academic writing as you begin a course, but you need to be competent at the end of your program of study. The starting point is always when you are assigned a piece of work. You may be asked to 1. Create a research document as if you were working in industry 2. Create a specific industry document 3. Write an academic paper 4. Create a cheat sheet or walkthrough for a work task 5. Create a laboratory report 6. Create a Standard Operating Procedure (SOP) These are all completely different things, and you will treat them different ways. If you understand how to approach them, you should be able to judge how to approach other variations of documents which might be assigned. At this level, we avoid being prescriptive, we leave a lot of room for interpretation and there are very many different, “right” answers. The first thing to do is to read the assignment text and parse it. * Exactly what is being looked for? * Is there a marking rubric? * If not, have the deliverables been specified (because if they have, you have found your rubric!!). A rubric is a marking scheme or guide which lets us mark student work in an objective and repeatable fashion. The lecturer wants to ensure that no matter who marks your work, they will give it the same grade. In any submissions do NOT use ATU logos, or those of any other third party. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://johnoraw.gitbook.io/gettingstarted/guidance-on-writing.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.