Arrange contents list, index. Leave the completion of an index if one is required
8.2.7 Word processing
For computing students it almost goes without saying that the best way to produce your report is with a word processor of one kind or another. These packages are far more effective than typewritten or hand-written work alone. Almost all word processors these days come with dictionaries and a thesaurus facility built in. In addition, many are equipped with equation editors that can help you produce neat equations embedded within your text. Alternatively, equation editors are available that can be used to ‘con- struct’ equations before pasting them into your report. The following is an example of an equation that has been pasted into the text this was produced using Microsoft Equation 3.0 which was installed in Microsoft Word. Notice how this equation has been given a reference number 8.1 in this case which you must always include to uniquely identify each equation you incorporate in your report. f N = 8.1 ∑NN − 1 S 2 N − 1 194 Chapter 8 n Presenting your project in written form Be careful when using in-built spell checkers. Many are based on American dictio- naries and will change words to their American equivalent; for example ‘center’ instead of ‘centre’ or vice-versa if you are an American reader. Spell checkers might also change spelling ‘errors’ within verbatim quotes you have used from other authors. Grammar checkers should also be used with caution. What might appear an elegant, well-constructed sentence to you might be changed automatically by a grammar checker. However, if you feel that your grammar is weak, these facilities are invaluable. While most students will use a WYSIWYG What You See Is What You Get word processor for example, Microsoft Word for their reports, for those undertaking more technical reports with lots of mathematical equations, a text formatter such as LaTeX pronounced LayTech may be more appropriate. LaTeX is a text formatting tool that takes a text document prepared by you and converts it into a form that can be printed. The text document is encoded in a similar way to HTML in that different markers within the document format the text in different ways when it is printed out. LaTeX has facilities for automatically numbering chapters, sections, equations, etc. It is mainly used within the computer science and mathematics fields and by professional publishers. Oetiker et al. 2008: 3–4 list the following advantages of LaTeX over conventional word processors: n The documents produced are ‘professionally crafted’ and look as if they have been ‘printed’; n Mathematical formulae are easily typeset; n You only need to learn a few commands that specify the structure of the document; n Footnotes, references, contents tables, etc. can be easily generated; n It encourages users to write well-structured reports because this is how LaTeX works; and n The tool is free and portable between systems. For those of you using Linux or UNIX, the chances are that your system already has LaTeX installed speak to your supervisor or technical staff for help. For those with Windows-based systems you can use a system called MiKTeX which can be downloaded from http:miketex.org . Macintosh users can use a similar system called OzTeX which is also freely available from numerous sites on the Internet.8.2.8 Tips
This section on report writing will conclude with a few report writing tips to help you. Bell 2005: 245–247 identifies a number of points that can help you discipline yourself and improve your writing skills: n Set deadlines. Your report will take a long time to produce. If you do not set yourself deadlines and stick to them, you will not finish on time. Using a report breakdown structure can help you to plan your time commitments more accurately. n Write regularly. Find your best time of day for writing and your favourite location. In other words, make sure that you ‘write when your mind is fresh’ and ‘find a regular writing place’ Saunders et al., 2007: 520–521. People often find they cannot write with distractions or when they are over-tired.Parts
» Projects in Computing and Information Systems A Student's Guide 0273721313 Pearson 2009
» Introduction What are computing projects?
» Computing project types What are computing projects?
» Programming in computing projects
» Degree structures Degree requirements
» Degree requirements for projects
» Overview Your supervisor Stakeholders
» Clients and users Stakeholders
» Evaluators and testers Stakeholders
» Overview How this book is arranged
» Taught degree projects versus research degrees
» Summary Projects in Computing and Information Systems A Student's Guide 0273721313 Pearson 2009
» A definition What is research?
» Originality What is research?
» Gaincontribution What is research?
» Knowledge and understanding What is research?
» Identify the broad area of study.
» Plan how you will perform the research.
» Gather data and information.
» Analyse and interpret these data.
» Present the results and findings.
» Review the field – i.e., perform a literature survey.
» Build a theory – based on your understanding and interpretations of the field.
» Test the theory – does it work?
» Reflect and integrate – i.e., update your ideas based on your ‘tests’ and contribute
» Intellectual discovery The research process
» Research methods Research methods
» List or multiple choice. Provides the respondent with a number of options to
» Scale. Used to rate the respondent’s feelings towards something.
» Ranking. Used to order a series of options. You should not provide too many
» Complex grid or table. Used to gather similar responses on a range of questions.
» Open-ended. Used to obtain extended, qualitative answers.
» Summary Further reading Action points
» Techniques and Information Sources
» Additional considerations Choosing a project
» Follow any guidelines precisely. Most institutions require specific information; for
» Proofread thoroughly and get someone else to check it. Any errors or omissions
» Introduction to the subject area. This will provide the reader with an under-
» Current research in the field. This will emphasise that your project is not based in
» Identify a gap. You should be able to identify some aspect of the field that requires
» Identify how your work fills the gap. Having identified a gap in the field, your
» Identify risks and solutions. It is also useful in a project proposal to highlight any
» Explicit sections Preparing a project proposal
» Reviewing your proposal Preparing a project proposal
» Exercise Projects in Computing and Information Systems A Student's Guide 0273721313 Pearson 2009
» The project process Introduction
» Definition The project’s stages
» Planning The project’s stages
» Initiation The project’s stages
» Control The project’s stages
» Closure. The project’s stages
» Complete a literature search and literature review of existing stock market prediction
» Develop a suitable artificial neural network model.
» Identify and collect suitable data for analyses and evaluation.
» Evaluate the model using appropriate statistical techniques.
» Complete final report. Setting objectives
» Step 1 – Work Breakdown Project planning
» Step 2 – Time estimates Project planning
» Step 3 – Identify milestones Project planning
» Step 4 – Activity sequencing Project planning
» Step 5 – Scheduling Project planning
» Step 6 – Re-planning Project planning
» Rolling wave planning Project planning
» Risks. Include a list of critical risk factors and means of dealing with these risks
» Organisation. If you are undertaking a group project it would be worthwhile
» Alleviate critical risks Introduction
» Identify risks Risk management
» Alleviate critical risks Risk management
» Controlling risks Risk management
» Research degrees versus taught degree projects
» A starting point Introduction
» The literature survey process
» Format of information Literature searching
» Tracing the information Literature searching
» Inter-library loans Literature searching
» Some tips for performing a literature search
» Critical evaluation Writing literature reviews
» Overview The past Introduction
» Introduction The software development life cycle SDLC
» Requirements definition Requirements capture
» Requirements specification Requirements capture
» Functional specification Requirements capture
» Design The software development life cycle SDLC
» Build The software development life cycle SDLC
» Test The software development life cycle SDLC
» Implementation The software development life cycle SDLC
» The earliest ’model’: build-and-fix
» The stage-wise and classical waterfall models conventional models
» explore the requirements of the system with the user – requirements capture, andor
» explore the technical feasibility of a system – experimental prototyping.
» Which development approach should I use?
» Which programming language should I use?
» Introduction Top-down and bottom-up development
» Top-down development Top-down and bottom-up development
» Bottom-up development Top-down and bottom-up development
» Verification Verification, validation and testing
» Validation Verification, validation and testing
» Testing Verification, validation and testing
» Who is involved with testing and evaluation?
» Test plans Miscellaneous testing types
» Quality assurance and quality control
» Exercises Projects in Computing and Information Systems A Student's Guide 0273721313 Pearson 2009
» Getting started – project initiation
» Managing the five project elements
» Introduction Dealing with problems
» Weakening Dealing with problems
» Personal problems Dealing with problems
» Hardware failure Dealing with problems
» Data availability Dealing with problems
» Discovering your workresearch has been done before
» Analyse what you are currently doing.
» Change what you are doing to achieve your aims.
» eliminate activities you don’t need to do; and
» be more efficient doing the things you have to do.
» Time management tips Procrastination
» Using your supervisor effectively
» Introduction Working in teams
» Team development Working in teams
» Managing the team Working in teams
» Teamwork tips Working in teams
» Considerations Writing and structuring reports
» Approaches to writing Writing and structuring reports
» When should I start writing?
» Identify structure. This relates to the content of your report, using a report break-
» Identify presentational style. You should also try to set standards at this stage on
» Draft the introduction. The introduction gives the reader an idea of the
» Develop the main body. The main body of your report is the next part you
» Articulate conclusions and make recommendations. Quite clearly, your conclu-
» Complete the introduction. As part of the evolutionary approach to writing,
» Write the abstract. You cannot really write a clear abstract for your report until
» Add references and appendices. Although you will be collating references and
» Arrange contents list, index. Leave the completion of an index if one is required
» Proofread, check and correct. It is vitally important to proofread your report after
» Introductionliterature review – the first chapter of your report should always be
» Main body – the content of which depends on the type of project you are un-
» Conclusionsrecommendations – summarises the contribution of the work and
» Style Writing and structuring reports
» Word processing Writing and structuring reports
» Tips Writing and structuring reports
» Presenting charts and graphs
» Common mistakes Data presentation
» Miscellaneous charts Data presentation
» Other data presentation Data presentation
» Introduction Referencing material and avoiding plagiarism
» Citing references Referencing material and avoiding plagiarism
» Listing references Referencing material and avoiding plagiarism
» Commenting program code Documenting software
» Writing user guides Documenting software
» The presentation content Visual aids
» Introduction. One or two slides that introduce you and your talk.
» Main body. The slides that constitute the bulk of your presentation and cover the
» Summaryconclusion. A few slides that summarise your presentation and perhaps
» Dealing with questions Oral presentations
» Poster preparation tips Poster presentations
» Introduction Preparation Demonstrating software
» Demonstration tips Demonstrating software
» Introduction Viva voce examinations
» Introduction Examiners and the marking of your project
» General. Examiners will look at the relevance and appropriateness of the topic
» Report. Examiners will look for clarity, consistency, an appropriate use of
» Defence. Examiners will assess the types of arguments you have made to support
» Other. Examiners will review the administrative issues of your project. For example,
» What was the research question?
» Is it a ‘good’ question? This involves a comprehensive literature review to ensure
» Has the student answered the question adequately?
» Has the student made an adequate contribution to knowledge?
» The project approach from a technical perspective i.e., not a project management
» General project considerations subject independent
» Literature reviewproject foundation Assessment criteria
» Project approachmethods Assessment criteria
» Results and contributions Assessment criteria
» Introduction Taking your project further
» Seeking funding Developing commercial software packages
» Copyright and patents Taking your project further
Show more