Project name

CDA Documentation Project - Test the procedure & support the newcomers

Project description

The group Collaboration, Devices and Applications (CDA) in CERN IT Department initiated a Documentation Project for moving static service documentation web sites containing service documentation to Markdown. For this purpose, software tools are being developed, instructions being written and  pilot testers contacted.

The student will have to:

1. apply the instructions in order to create a new web site according to the policy for site naming, hosting, authoring.
2. observe new-comer users' reactions to the procedure, the tools and the suggested rich-text editors.
3. identify shortcomings in any area of point 2 above and report to the documentation-project members.
4. document tips in form of FAQs and/or discourse articles.
5. make recommendations to the documentation-project team for an optimal user experience.
6. disseminate the instructions via alternative methods, namely online tutorials.
7. convert some of the groups' own service documentations to test the process in operation.
8. make short videos based on the Instructions.

Required skills

Good english (spoken and written) B2 CEFR level (Common European Framework of Reference).
Understanding Information Technology (IT) tools. Linux sophisticated user knowledge would be ideal.
Facility with video recording and editing (mostly screen capture).
Good communication skills. The tasks require contact with many users and experts.
Availability for an internship contract, at least 50% working time (2 days per week and 3 days per week the following week) for at least 3 months, with possible extension up to 6 months. Internship salary is 1500CHF/month for a 100% contract (40hrs per week).
Project can start in the 1st or 2nd quarter 2020.
Contact Maria.Dimou@cern.ch, with CV, recommendation letters and university grades.

Learning experience

We are working with Open Source tools which are the best ethical and technical quality attitude to have in computing.
The technical gain will be great for the student and the contact with the CERN IT experts and users will be very enriching.

Project duration

6 months

Project area

Learning

Contact for further details

Maria Dimou

References

Documentation strategy presentation (requires CERN login).

Project progress notes (requires CERN login).

CERN group

IT-CDA

Status

Submitted Submitted by Maria Dimou on Wednesday, May 22, 2019 - 15:37.