Documentation Project Notes

The purpose of this page is to collect ideas/suggestions for the new Informatics documentation site. Nothing here is written in stone but to promote discussion.

Suggestions for appearance of site.

  • Use Informatics header and footers which include a search facility
  • Icons and boxes on home page should be same size
  • Support options menu items must expand/collapse (will do this shortly using 'nice menus' module)
  • Page should include the date of editing
  • Page will include a feedback button.
  • This Front Page with the help desk content (or some variant thereof) and service status as what the user sees first would be my choice, way way over any of the others - timc.

Suggestions for Informatics Web Design Guidelines.

  • Make sure that spelling and grammar are correct:-)
  • Using all capital letters in a header appears to be perceived as bad practice
  • Title pages should not be centered
  • Avoid italics, use emphasize instead
  • Avoid bold use strong instead
  • Don't say "click here" when using links
  • Avoid the use of colloquialisms eg "You need to do something" should be written as "You should do something"
  • Avoid platform specific references. eg Try to say dice instead of f13 or sl5.
  • When copying html from old site, be aware that drupal seems to do more in the way of formatting so check that all html tags are necessary. (You may find that they are not.)
  • Make sure line breaks are in the correct place.

Questions about content.

  • Mark old documentation as "moved" on old site. Add as a comment at the top of the html page "The content of this page has been moved to the new documentation site", with the date and your uun. I have marked a few that I have found.
  • If some info is copied from the support FAQ add a comment in the new page.
  • Compile a list of services provided by the School and IS
  • Check categorisation and content of FAQ
  • Where does information about kerberos fit in?
  • Where does user documentation for the School Database fit in? Mostly this should be on svn.theon/trac, although I would expect that School/DICE specific, new user and service entries to exist here (some with links back) - timc.
  • Do we have a recent ie Sept 2010 version of the unix tutorial for the students introductory talk?
  • Some references to site liason CO. What should this be replaced with? For conferences CEG appoints liason CO.
  • How much should we copy over and how much should be rewritten? If content requires to be rewritten then who does it? The Web documentation is a good example. There is lots of it but some parts are quite old.


-- AlisonDownie - 31 Mar 2011

Edit | Attach | Print version | History: r16 < r15 < r14 < r13 < r12 | Backlinks | Raw View | Raw edit | More topic actions...
Topic revision: r13 - 05 May 2011 - 14:30:19 - LindseyBrown
This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
This Wiki uses Cookies