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 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 c) Improve/update the pages as required.

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.

In conjunction with this mail, a related mail will be sent to the Computing Domain Coordinators asking them to look to the organisation of their TWiki pages.

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

Thanks for your help - Stephen Haywood.

Mail to Domain Coordinators

Dear Domain Coordinators

As I indicated in my last mail, I want to start to tidy the TWiki so that we can manage it better in the future. You will have seen a mail I sent to all users. I would like you to take responsibility for the pages in your domain. In particular, in the first phase (Autumn 2006), please ensure that the pages satisfy the Rules https://twiki.cern.ch/twiki/bin/view/Atlas/DocumentationManagementTWikiRules, and especially that the structure (as indicated by the Metadata - see https://twiki.cern.ch/twiki/bin/view/Atlas/DocumentationManagementTWikiRules) is sensible. This should not take too long - in some cases, there may be almost nothing to do. At most I expect there will only be a couple of days work ... it doesn't have to be done by yourself; in fact I would strongly encourage you with large Domains to appoint a Domain Documentation Responsible.

I encourage you to look at the page on the proposed management of the TWiki: https://twiki.cern.ch/twiki/bin/view/Atlas/DocumentationManagementTWikiManagement

I know you are under pressure to get ready for Release 13, which is a high priority. I hope that if you do not have the time yourself, you will find someone who does.

After Release 13, I hope we can start to focus on the Doxygen documentation and associated web material. So the second phase of improving the TWiki pages will be for the Domains to actively review their pages.

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

Manuella Vincter

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


Major updates:
-- StephenHaywood - 31 Oct 2006

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

Edit | Attach | Watch | Print version | History: r15 | r7 < r6 < r5 < r4 | Backlinks | Raw View | Raw edit | More topic actions...
Topic revision: r5 - 2006-11-03 - StephenHaywood
 
    • Cern Search Icon Cern Search
    • TWiki Search Icon TWiki Search
    • Google Search Icon Google Search

    Atlas All webs login

This site is powered by the TWiki collaboration platform Powered by PerlCopyright & 2008-2022 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
or Ideas, requests, problems regarding TWiki? use Discourse or Send feedback