How To Organize Your Project Wiki

By samooresamoore (1222718770|%a, %b %e at %I:%M%p, last edited at 1222718770|%a, %b %e at %I:%M%p)

In this announcement I address questions I have gotten from a few students related to how they should organize the project wiki.

Think about the context of this wiki. It is being used as an educational resource for an incoming analyst; you, the author, is the outgoing analyst who is instructing the incoming analyst about this topic. So most of the content will be organized in a way that you think would help the incoming analyst learn about the topic. At the same time, this is a class and you want to impress me about your knowledge about the skills, techniques, and technologies that you have learned during the semester.

Here are some insights into how I think you should think about organizing your wiki:

  • The wiki home page should provide a guide as to what can be found on the site. It should be easily scannable. It should also provide links into the various parts of the site.
  • Your site should probably have the following sections:
    • Background information
      • An evaluation of the resources you used
    • Recent current events — something like a timeline, a series of blog entries; something that gives the incoming analyst an idea of what's been going on with the company recently.
    • Instructions on how to keep up with ongoing current events
      • Your blogroll will be accessible within the site
      • An evaluation of the RSS feeds that are in the blogroll, including reliability but also what the user can expect to find in each of the feeds
    • Descriptions (for me, the professor) about what techniques and technologies you used, how you used them, what they resulted in
  • The menu system should help the user navigate the site.

Don't forget that this site will be made public at the end of the semester.

I will write about this more as the semester goes on, but I've already gotten some questions about this so I thought I'd put in my two cents. (BTW, I am adding this information to the project page.)

Unless otherwise stated, the content of this page is licensed under Creative Commons Attribution-NonCommercial-ShareAlike 3.0 License