WebDev0

If you hear an expert talking about the Internet and saying it [does] this, or it will do that, you should treat it with the same skepticism that you might treat the comments of an economist about the economy or a weatherman about the weather. Danny Hillis, Computer Scientist, 2013

Session 7: Technical Documents

Technical Documents

If you are producing a web page for just yourself, all that you need to consider is the code that is used on the site. However producing a web site commercially involves more than the code. You also need to produce technical documentation. The purpose of this documentation is to reduce site maintenance, especially if the site is going to be maintained by someone else.

At the very least these technical documents should include the following headings:

  1. Project Goal - What is the site trying to achieve.
  2. System Infrastructure - What web Server is the site to be hosted on, what changes if any have been made to the web server, what code libraries have been used.
  3. Site Map - Map of the page links internally - Search engines like to find the xml version of this document.
  4. Internal page characteristic - List what is on each page and how the page functions.

Larger sites (with bigger budgets and teams) have more comprehensive documentation.

This site has an example of a simple technical documentation that you can use as a guide. It consists of Style Guide (a document that is used to maintain consistency of writing across all the pages of the site) and a Web Guide to help maintain a consistent look and feel across the site. The technical documents also ask for a site map, the example give you two types, a diagram which helps people understand the structure of the site and an xml version which computers can understand. Many search engines ask developers to provide the xml site plan as part the Search Engine Optimisation of the site.

Assessment Part C requires you to produce simple technical documents for your site. This assessment must also consider accessibility and usability. Many tools exist to test accessibilility including AC Checker and Wave. Usability will be tested using a user survey. Many resources exist to create online surveys, eg Survey Monkey. Create a survey about the user experience of using your site, attach your survey to your site, get more than 10 people to take your survey (use your contacts and your class mates) and present your findings as part of Assessment Part C due next week.

Assessment Part C (Technical Documents) is due in two weeks