Malt-related project: New documentation testing for up-to-dateness and functionality

Project name

Malt-related project: New documentation testing for up-to-dateness and functionality

Project description

The group Collaboration, Devices and Applications (CDA) in CERN IT Department provides a big number of services which are very visible to the end-user. For a complete list of services, please check our internal site.

These services are documented in many pages written in Twiki, Sharepoint, Drupal or Markdown. In a current attempt to standardise the way service web sites (detailed User Guides) are written across the group, we desire to clean-up, migrate and/or create documentation page using modern and open technologies (Markdown, Gitlab and Openshift).

The student will play the role of the CERN Newcomer-End-User. S-he will use our services while going through existing documentation pages to identify the parts that are out-of-date, non-functional and/or missing. S-he will make recommendations to the service managers on their service documentation structure, usability and content.

S-he will equip the new documentation pages with very short videos where necessary.

Required skills

Good understanding, speaking and reading of the english language.

Good communication skills.

Knowledge of web editing and publishing tools.

Knowledge of screen capture and recording tools.

Learning experience

The diversity of our services will give the student a rich in-sight of modern, technical and popular tools, workflows, recommendations and applications, for example: video conferencing, webcast & recording, event schedule tools, the CERN Document Server (CDS), document conversion, printing, e-mail, IP telephony, the Invenio Digital Library Framework, Windows environment tools, web services, authentication and authorisation services, recommendations for e-learning video tools and more. Most of these services are provided and supported on a range of devices, such as desktops, laptops, tablets and smartphones.

Detailed knowledge of legacy and future website design will be acquired (CERN being the place where the first web site of the world was born).

The group contains many young and dynamic technical people, ready to help and learn, at the same time.

Project duration

up to 6 months at 50% working time (20hrs per week)

Project area

Learning

Contact for further details

Maria Dimou

References

  1. Slides on the CERN IT CDA Documentation strategy.
  2. Current documentation of IT CDA/IC section services (click on the pages behind the dynamic bubbles).
  3. Reflection on existing CDA documentation
  4. Internal Documentation Strategy note
  5. Another (complementary) project on Documentation conversion to Markdown This project is stalled until the next student round.

CERN group

IT-CDA

Status

Accomplished
Reference to the project tracker
Malt-related-projects
Submitted by Maria Dimou on Friday, October 26, 2018 - 13:30.
Student info
Student name

Catarina De Sousa Vieira

University

Université de Genève

CERN supervisor

Maria Dimou

Thesis
Thesis type
Master
Project started 07 Jan 2019
Project finished 06 Jun 2019
Defence status
other