Following are explanations of the various sections that usually make up a report:
If the report is short, the front cover can include any information that you feel is necessary including the author(s) and the date prepared. In a longer report, you may want to include a table of contents and definitions of terms.
Consider using a Microsoft Word Cover Page to improve the look of your title section. See https://support.office.com/en-us/article/Add-a-cover-page-79df80ec-266d-46d6-9382-6d70f1d13777
for information on how to insert a Cover Page.
The first page of the report needs to have an introduction. You will explain what the report is about and why it is being made.
There needs to be a summary of the major points, conclusions, and recommendations. It needs to be short as it is a general overview of the report. Some people will read the summary and only skim the report, so make sure you include all the relevant information. It would be best to write this last then insert it after the introduction section so you will include everything, even the points that might be added at the last minute.
This is the main section of the report. The previous sections needed to be written in plain English, but this section can include jargon from your industry. There needs to be several sections, with each having a subtitle. Information is usually arranged in order of importance with the most important information coming first.
Conclusion / Recommendations:
This is where everything comes together. Keep this section free of jargon as many people will read the Summary and Conclusion and not the rest of the report so you need it to be clear.
This is where you use what you have written in the body section to make a conclusion (your decision) and recommendations (what you think should happen.) Write this section in plain English and explain your recommendations, putting them in order of priority.
Note: As well as having the correct content, your report should also look professional. Consider using Microsoft Word to apply a Style to your headings and body text to improve the overall appearance of your report. See http://www.gcflearnfree.org/word2013/29
for more information on how to use Styles.
Tips for Good Writing
Here are a few tips for good writing:
Keep it simple
Do not try to impress; try to communicate. Keep the sentences short and to the point. Do not go into a lot of detail unless it is needed. Make sure every word needs to be there and that each contributes to the purpose of the report.
Use an active voice rather than passive.
Active voice uses fewer words than the passive voice and gives impact to the writing by emphasizing the person or thing responsible for an action. The advantage of the active voice is that it makes the writing move smoothly and easily. Here is an example: Steve loves Amy.
The passive voice is used to show interest in the person or object that experiences an action, rather than the person or object that is actually performing the action. Passive voice uses more words and is not generally used in academic writing. Here is an example: Amy is loved by Steve.
Grammar and punctuation are important
Having someone proofread is a good idea. Remember that the computer cannot catch all the mistakes, especially with words like “red, read” or “there, their.”
These bars refer to links usually at the top of a page, placed inside a bar, which help navigate us through a website. These are important because this is one of the first things a user will look at, especially if they know what they are looking for. If not done correctly, it can cause problems for the user and frustration. It is important all of the links work, and they also stand out, because without these links, the website would be only a homepage and nothing else.
Approach to take for the assessment:
Approach to take for the assessment:
Use the six areas listed below as the main headings in your report. You can modify the way they are written if you wish, as long as the meaning remains clear:
1. Advanced tools and techniques
2. Standards and conventions
3. Asset management and file management
4. Data integrity and testing procedures
5. Legal, ethical, and moral responsibilities
6. Relationship between standards and conventions and legal, ethical, and moral considerations
For each of areas 1, 2, 4 and 5, take the following approach:
Identify between six and ten subtopics that you wish to include. Suggested lists of subtopics are on the next page.
For each subtopic, complete the following:
• What is it? Explain
• The advantages and disadvantages of it? How does it affect the quality of websites? Discuss
• Whether it has been done in the first site and how well? Provide examples from the code or screenshots of the site. You can also talk about pros and cons of what the site has done here if you wish.
• Whether it has been done in the second site and how well? Provide examples from the code or screenshots of the site. You can also talk about pros and cons of what the site has done here if you wish.
You may wish to write subheadings under each subtopic in your report before you tackle each of the above bullet points. Your subheadings could be something like “Explanation. Discussion. Worldvis. Virtalis.”
For area 3, take the following approach:
Explain how asset management and file management are applied in developing websites.
Discuss why it is important that asset and file management techniques are effective and appropriate.
Suggested subtopics are on the next page.
For area 6, take the following approach:
Discuss the relationship between standards and conventions and legal, ethical, and moral considerations in relation to the requirements of websites.
In other words, how is the use of standards and conventions linked to the legal, ethical, and moral things we must consider when making websites.
Suggested list of subtopics:
Advanced tools and techniques
- navigation bars
- search functions
- navigation icons
- digital-friendly style sheets
- use of external and/or multiple cascading style sheets (CSS)
- use of semantic layout techniques
- use of absolute/relative positioning
- use of responsive design (liquid layouts) so the content adjusts to the size of a user’s screen.
- commenting code
- conditional commenting
- image positioning with code
Standards and conventions
- use of metadata to aid searching
- use of a doc-type tag to indicate language and version used in the creation of the page
- use of the title tag
- correct opening and closing of HTML tags
- Indenting code
- separation of content from layout
- use of index, home, or default as file name of start page
- navigation placed consistently
- commented code
- object positioning
- using a shopping cart graphic and placing the shopping cart link in the upper right section of a page
- underlining links (and not using underlining unless it is for a usable link)
- a change in colour once a link has been activated
- using familiar, easy to read fonts
- consistency between web pages text colour and styles
- automating an order confirmation so that the customer is reassured that their order has been received and will be processed
- regular updating of the site
Asset management and file management
- a folder structure is used to keep assets separate
- sound files are provided in a compressed format
- video files are provided in a compressed format
- images are optimised (compressed, but not pixelated)
- a file naming convention is used
- image backgrounds are tiled repeats to save file space.
Data integrity and testing procedures
- proofreading for accuracy
- websites look different in different browsers
- testing for function in multiple browsers, perhaps using an emulator such as screenshots.org
- checking of dead/dysfunctional links
- checking the requirements of bandwidth and speed to ensure the website functions
- checking that e-commerce functions are secure and functional.
Legal, ethical, and moral responsibilities
- legal copyright – for example, reminding users that content must belong to them in order for them to be able to share it, and ignoring this can result in charges and fines
- compliance with the Fair Trading Act – for example, the need for a site to ensure that users agree imagery is not subject to copyright before uploading it
- moral – for example, ensuring that visual imagery on a site is appropriately inclusive and does not prejudice any particular group
- issues relating to security and authentication – for example, how users identify themselves on a site where they are required to log in and comparing this with a site that does not require logging in
- ethical – for example, ensuring that users are of an appropriate age, particularly where online shopping is offered.
The width of a table in which web data is formatted can be set at a specific (absolute) size that will not change no matter what the size of the web visitor’s browser window or it can be allowed to change in size (relative) in relation to the web visitor’s browser.
Web visitors habitually scan pages looking for objects that confirm they are in the site they seek. An image, slogan or colour combination that immediately identifies a business or product visually will be remembered more easily than the business or product name.
A textual navigation aid, showing the path a visitor has taken to arrive at the web page they are currently viewing. The path is shown from site entry to current position so that a person can more easily find their way back to a level when they realise they have selected a wrong link (route).
Applying a shadow to a shape or graphic gives the illusion of depth so that the top ‘layer’ appears to be standing out from the text and other elements shown on the web visitor’s screen.
Coding that protects a web page from being hacked with the view to reading or changing code, or accessing data that is considered confidential.
Text or buttons that take a web user to a web page outside the web site that they are currently visiting. They should be formatted in a consistent style and listed separate from a paragraph or report so that the user is aware that they are leaving the host web site.
A web navigation term. Normally a button with text or a graphic that links web pages within a site back to the site’s home page. The button normally remains in the same location of each web page. Text is formatted in title case and the graphic used is normally the outline of a house so that it is easily identified by all web users.
Hyper Text Markup Language. This is the main language used for creating web pages. It is a code that tells the web browser what to display, where and how. All computers are programmed so that they can read HTML files. This is why web pages can be viewed in any country – all that is needed is a computer and an internet connection.
HTML opening and closing tags
Positioned each side of a web content instruction, these tell a browser where an element, such as a heading, paragraph, italic text formatting, starts and finishes. The content between the tags should be written in lower case as this is a web standard. Line breaks are the only content element not requiring a closing tag. Images will not display if the file location is not specified between the tags.
Text or buttons that take a web user to a web page inside the web site that they are currently visiting. They should be formatted in a consistent style and are often contained in the body of text so that the visitor can seamlessly transfer to another section of the site to obtain specific information or move to an interactive tool such as an email form, interactive questionnaire or checkout.
Simple web page structures that are commonly used. These structures contain boxes of a variety of sizes into which text, images or text and images can be displayed. Navigation tools will be placed in a top or side bar. A web site’s unique point of difference is attained through colour, text styles and content.
A document providing a textual or graphic display of all web pages within a web site. Normally displayed in a hierarchy for ease of navigation, it also assists search engines to identify topics that may assist their users.
Describes an online document. Essential for HTML and XHTML documents. You can only have one of these. It will appear in the top browser window. It has nothing to do with the HTML file name you saved it as.
Uniform Resource Locator. The global address of all documents on the World Wide Web. The print screen below shows the URL for the New Zealand Google home web page.
Checks that the web page code is correct so that it will work effectively in a range of web browsers – that it is compatible. This will ensure the web page is viewed as intended by online visitors and that its content can be identified by search engines.
World Wide Web Consortium. An organisation that aims to maintain the usability of the web by recommending standards so that web pages are accessible to all web visitors. Go to http://www.w3.org/
to learn more.
All elements found on a web page. This will include text, images, video, animations and sound.
A way of soliciting a response from web visitors. This could take the form of a ‘Like’ button, a questionnaire, quiz, a rating system or any other method that holds the visitor’s attention and encourages them to spend more time exploring a web page.
Web style or presentation
The way information appears on a web visitor’s screen will influence how long they stay on the web page. If there is too much text or the layout is confusing, a visitor will often move to another web site. Elements such as colours, font size and amount of scrolling required will also influence the popularity of a web page.
Creating a visual plan of how a web site or page will be set up. This illustration is likely to contain the position of headings, text, images and other elements with limited explanation.
World Wide Web. An unlimited and increasing number of documents (pages) that can be accessed through the Internet. The information contained within each document (page) may not be true or verifiable.
Links formatted as boxes that are activated by a mouse click and will take the web visitor to another page within the web site. They can be labelled with text or an appropriate graphic. Consistency of alignment, style, size, colour coding and text formatting across the web site is essential. Oversized and block capital buttons are inappropriate as they detract from the web page content.
Software that checks that a website works effectively from the point of view of the web visitor. Commercial validation packages will check all codes and report problems such as broken links, slow downloading, spelling errors (in many languages), and password protection. This is necessary to ensure that the web visitor experience matches the intentions of the web designer.
An image that can be identified with a company, organisation or product. Most logos have been registered by the organisation they are identified with and are therefore subject to copyright laws.
Cascading style sheets are used to design the user interface - the visual display - of a web page that a web visitor will view. The sheets can be programmed with different text fonts, enhancements, colour, alignment, line and word spacing. The sheets can be layered over one another and, for example, over a graphic background, so that a more interesting and effective visual display is created for the web visitor.
A declaration of the document type that must be coded at the start of a web page to ensure that it is displayed correctly. The declaration states the HTML programming code version and whether the page is to be made available to the public or specified web users.
A web page that downloads quickly and shows all elements is considered ‘friendly’. If a web page takes too long to download or elements such as images are missing, the web user may consider the page ‘unfriendly’ and click to another site causing the potential loss of a customer.