ATLAS S&C Documentation Workshop

Monday Dec 11, 2017, 9:00 AM → 1:00 PM Europe/Zurich

40/S2-D01 - Salle Dirac (CERN)

Davide Costanzo (University of Sheffield (GB)), Torre Wenaus (Brookhaven National Laboratory (US))

The documentation toolset (both narrative and code documentation) has been growing rapidly in the open source world. This workshop is to help ATLAS identify promising directions and tools to pursue, within the context of preserving adequate stability, continuity and preservation of investment in the existing documentation.

For information and to provide advance input (much appreciated) see the whiteboard document linked below.

Whiteboard for input and notes

Workshop summary report presentation, Dec 15

9:00 AM → 9:10 AM Introduction

Speakers: Davide Costanzo (University of Sheffield (GB)), Torre Wenaus (Brookhaven National Laboratory (US))

9:10 AM → 9:30 AM ATLAS S&C documentation overview

Doc project overview and status, what's the team's mandate, what is supported, what are the team activities, who is doing what, what is the current plan going forward

Speaker: Maria Smizanska (Lancaster University (GB))

DecWorshopTalk.pdf

9:30 AM → 9:50 AM ATLAS S&C documentation tools

Closer selective look at tools in use like doxygen, jekyll, work underway/planned to integrate them and others; ie a more technical look at the current toolset and its evolution

Speakers: Adam Edward Barton (Lancaster University (GB)), Alexey Boldyrev (Moscow State University (RU))

Doxygen_11_12_2017.pdf

Jekyll.pdf

Status_AFS_to_EOS_11_12_2017.pdf

9:50 AM → 10:05 AM IT documentation and training tools

Speaker: Maria Dimou (CERN)

A screenshot of our new draft web site made with Jekyll

IT e-learning news & Documentation initiative

the same presentation hosted in EOS

Video on Afs to EOS migration for web sites

10:05 AM → 10:35 AM Modern documentation tools and approaches

Experience, ideas, possible directions... from the speakers and their curation of the advance input

Speakers: Giordon Holtsberg Stark (University of Chicago (US)), Mario Lassnig (CERN)

S&C 2017 - Modern Docs and Tools(2).pdf

10:50 AM → 11:15 AM Survey of documentation tools and practices in other experiments

Speaker: Edward Moyse (University of Massachusetts (US))

Survey for 2017 doc review.pdf

11:15 AM → 11:35 AM Software education

Speaker: Stefan Kluth (Max-Planck-Institut fur Physik (DE))

sw_education_docws.pdf

11:35 AM → 1:00 PM Whiteboard discussion, conclusions, actions

Speakers: Davide Costanzo (University of Sheffield (GB)), Torre Wenaus (Brookhaven National Laboratory (US))