DocumentationManagementTWikiMailNov06

Introduction

Mails I intend to send to

1. All ATLAS Users (I guess this has to go to AtlasGen)
2. Domain Coordinators or Domain Doc Coordinators

Mail to Domain Coordinators

Dear Domain Coordinators (Computing & Physics)

We want to start to tidy the TWiki so that we can manage it better in the future. We encourage you to look at the plan we propose for the management of the TWiki: https://twiki.cern.ch/twiki/bin/view/Atlas/DocumentationManagementTWikiManagement.

We would like you to take responsibility for the pages in your domain. In particular, in the first phase (up to 30 Nov), please ensure that the TWiki pages in your domain satisfy the Rules: https://twiki.cern.ch/twiki/bin/view/Atlas/DocumentationManagementTWikiRules, and especially that the Metadata structure is sensible; see https://twiki.cern.ch/twiki/bin/view/Atlas/DocumentationManagementTWikiRules#Metadata

The Rules outline a set of simple technical requirements for TWiki pages to facilitate their management. We know you are under pressure to get ready for Release 13, which is a high priority. So what we are requesting in the first phase should not take too long - in some cases, there may be almost nothing to do. At most we expect there will only be a couple of days work ... it doesn't have to be done by yourself; in fact we would strongly encourage those of you with large Domains to appoint a Domain Documentation Responsible.

We propose that the second phase will take place after Release 13. In this phase, we will be asking you to review (and improve) the contents of your web pages. We also propose to look at the Doxygen documentation.

Note: soon we will be sending a general mail to all ATLAS users to engage everyone in the process. You are responsible for the Domain and the top-down approach; other users are adding pages at the "bottom", so we hope to engage them by contributing in a bottom-up appoach.

If you have any concerns about this process or would like advice, please contact us.

Thanks for your help - Stephen Haywood (Computing Documentation Coordinator) & Maria Smizanska (Physics Documentation Coordinator)

Mail to all ATLAS Users

Dear ATLAS Members

The TWiki is a very popular Web medium to which people are contributing information. This popularity arises from the ease of use.

The downside to this is that it has become a large, sprawling "garden". There are coming on for 4000 ATLAS TWiki pages. Many are quite good and contain useful information. However, there is a lot of "rubbish" and pages which have become outdated and obsolete. I have been asked to take responsibility for the ATLAS Computing Documentation, in particular, the oversight of the TWiki. I will extend this oversight to technical side of the complete TWiki, although Maria Smizanska will be responsible for the contents of the Physics part of the TWiki.

To manage the TWiki, the first step is to tidy it up. To achieve this, I request that everyone who is responsible for TWiki pages to a) Check if these pages are still needed; if not delete them. b) Ensure that they follow the Rules: https://twiki.cern.ch/twiki/bin/view/Atlas/DocumentationManagementTWikiRules

The deadline for this process is 30 Nov 2006. After this time, the Documentation Team will start to look at the pages and those which fail to satisfy the Rules may be removed. The more you do to help, the easier our job will be.

This is the first phase of the process. After Release 13 of the Software in January, we will start the next phase where the emphasis will be on improving the content of pages and trying to get them reviewed.

A related mail was sent to those whom we have identified as the "Domain Coordinators": https://twiki.cern.ch/twiki/bin/view/Atlas/DocumentationManagementDomainContacts They will be looking at the TWiki from the top-down. Please interact with them, as approporiate.

If you have any concerns about this process or would like advice, please contact me.

Thanks for your help - Stephen Haywood.

Mail to Ed Moyse

Hi Ed

In order to manage the TWiki pages, it would help if a couple of fields could be added to the TWiki Template.

1) Responsible person for page

2) Name of last Reviewer and date

As I have done in https://twiki.cern.ch/twiki/bin/edit/Atlas/DocumentationManagementTWikiMailNov06

Would this be OK ?

Cheers - Stephen

Mail to Individuals

Sasha Rozanov and Jens Weingarten

• 1104027 - Pixel Stave data
• 4002 etc - Pixel Stave data
• 510072 etc - Pxiel Module data

Christian Arnault

• 805 - Kit validation

Sandrine Laplace

• CaloEvolution1100 etc - files all seem empty

Manuella Vincter

• LArEndcapP3CommissioningCrate01A etc - is this best form for storing many similar pages of info ?

Rick St. Denis

• RStAODG23Nov05 etc - personal files, containing batch o/p - should be elsewhere, eg Sandbox

Rolf Seuster

• TsJob1 etc - personal files, containing batch o/p - should be elsewhere, eg Sandbox

%RESPONSIBLE% StephenHaywood
%REVIEW% StephenHaywood - 31 Oct 2006