Standards

From Digital City Design Workshop 07

This page focuses on defining standards for our collaborative resources - the wiki and the course locker,

Contents

Best practices for using the course locker

the course locker can be found on athena at /course/11/11.941/FILES

Put files in the course locker, link to them on the wiki

  • Once you're in the course locker, be sure to go to the FILES sub-folder. All of our group's files should be stored within that sub-folder.
  • It really doesn't matter how you organize files within this folder, as long as you create a link in the right place on the wiki.
  • Of much greater importance than where you put your files is keeping files where they are after you've created a link on the wiki. If you absolutely must move a file, or if you upload an updated version, be sure to update the wiki link to reflect the change.
  • To maintain a reasonable, reliable organization, we recommend you file according to the following protocol:

Folder structure

  • DO NOT NAME FOLDERS WITH SPACES OR SPECIAL CHARACTERS
    • only use letters, numbers, and the characters "-" or "_" to represent spaces
  • Top folder is to be named with your kerberos id
  • 2nd folder is to be named with the presentation. For example: c_outram-research-presentation-1
  • 2nd folder will contain the presentation file (powerpoint file in the case of the research presentations) and must also contain the following folders: PDF out, images and text.
  • Text folder will contain both the text file for the presentation as well as a 'sources file' that includes references for all images

File naming

  • DO NOT NAME FILES WITH SPACES OR SPECIAL CHARACTERS
    • only use letters, numbers, and the characters "-" or "_" to represent spaces
  • For presentation files: "kerberos id, sequential number, short description (dot) extension
    • eg: c_outram-1-zaragoza-water-wall.pdf

Best practices for using the wiki

(coming soon :)

  • page naming
  • information chunking
  • page linking
  • group pages
  • uploading files
  • categories