Project Guide: How To Set Up a New Project

Whenever we start a new project, it's helpful to put a few resources in place so everyone knows where to look for information. Here is a list of what should be there:

On Our Wiki:

  • Create a publicly visible jump page "hci.rwth-aachen.de/projectname" for the project. The page URL should be short, but easy to read, spell, and pronounce. Use hyphens if you need multiple words. Avoid other special characters or camelCase. For example, this page is called "project-guide". We don't use subdirectory paths in our wiki.
  • On that page, put a project title, a paragraph summarizing the project for the public, and a matching image if you can think of one. Add a section with team members and their roles (research assistants, Hiwis, thesis students, and Jan), and who to contact about the project (by default, the lead research assistant).
  • Include a publications section that automatically lists any project-related publications, using our Joomla i10 plugin (see https://hci.rwth-aachen.de/i10content-help). For this to work, flag project-related publications with an appropriate tag in their BibTeX entry.
  • At the bottom of the public page, include a link to a second page "projectname-internal". Make that page readable only for registered and logged-in wiki users. Put any internal info there that is not appropriate to put on the public page. For example, it could include meeting notes, work packages, etc. Include a list of all project members, including external members, with their full names and contact details (email, phone).
  • If it's a funded project, update hci.rwth-aachen.de/funding appropriately.

On oliver:

  • Create a directory with the project short name in Public:Research Projects. If it's still just a proposal, put it into the Proposals subdirectory there.
  • Follow the README.TXT on oliver in the Public folder for the directory structure inside the project folder.
  • In particular, please follow the naming scheme using the date prefix for files and/or folders so that they sort appropriately. This makes it easier to find relevant files, like the submitted version of a project proposal.

On Slack:

  • Create a channel #projectname and set an appropriate description. Invite all team members to it. Make the channel private only if you expect closely guarded secrets to be the topic of the channel that other registered Slack users are not allowed to see. Otherwise leave it public (you can message individuals directly for secret items.) All contents in private channels is lost if we ever need to export our data to move away from Slack.

At the next Research Breakfast, let everyone know when you've set up such a project so people know that it exists.

We use cookies on our website. Some of them are essential for the operation of the site, while others help us to improve this site and the user experience (tracking cookies). You can decide for yourself whether you want to allow cookies or not. Please note that if you reject them, you may not be able to use all the functionalities of the site.