Naamgeving en Nummering in SmarTeam

Transcriptie

1 Naamgeving en Nummering in SmarTeam Nikhef number: Item number: Date: 6/1/2010 Page: 1 of MT AA0844 Status: In Work Revision: A.1 Project: Bedrijf Intern Technical Departments Department: Mechanical Technology Top folder: SmarTeam Created by: M.J. Kraan Checked by: Distribution list: Approved by: National Institute for Subatomic Physics Science Park 105, 1098 XG Amsterdam The Netherlands

2 Naamgeving In SmarTeam worden documenten opgeslagen in een project structuur. De Project structuur (rood) en Folderstructuur ziet er als volgt uit: Programma Project o Afdeling Topfolder Subfolders De structuur vanaf Programma tot Afdeling wordt door de SmarTeam administrator aangemaakt. De Topfolder en subfolders kunnen door SmarTeam gebruikers worden aangemaakt. Voorbeeld Project structuur: 38 ATLAS ID upgrade pixel detectors o ME Mechanical Engineering Hetzelfde voorbeeld in SmarTeam: De nummers voor het Programma (38) en Project (38640) worden bepaald door het Directie Team. De twee letters voor de afdeling zijn de afkorting van de afdeling. De Programma- en Projectnaam mogen samen max. 32 karakters bevatten i.v.m. met de ruimte in het tekeningenkader. 2

3 Documenten moeten worden opgeslagen in de folderstructuur het project. Alleen bij het opslaan in een folder zal het document automatische het juiste Nikhef nummer krijgen en zichtbaar zijn in de Projectstructuur. Bij het opslaan van documenten in bijv. een Department of Project zal het zweven in de database en alleen vindbaar zijn met een zoek opdracht. Een Topfolder is hiërarchisch de hoogste folder, folders hieronder noemen we subfolders Activeer de afdeling en klik op Documents: De Topfolder Layout Pixel met hierin de verschillende documenten 3

4 Advies voor naamgeving Doel Het doel van dit advies is om een consistente en logische benaming van documenten te verkrijgen in SmarTeam. Dit zal o.a. het zoeken door collega s vereenvoudigen. Algemeen advies Naamgeving in het Engels. De benaming dient functioneel te zijn, beschrijf de nuttige functie van het onderdeel. De benaming dient bij voorkeur uit minimaal twee woorden te bestaan: Voorbeelden: Support Frame, Bare Disk, Services Support Gebruik bij voorkeur geen afkortingen en vage woorden. Dus niet: PMT OM1, test, frame Geef duidelijke en logische namen zodat collega s gemakkelijk kunnen zoeken en direct weten wat ze er kunnen vinden. Topfolder advies Topfolder naamgeving moeten eenduidig (specifiek) zijn en afgesproken worden binnen het project. De Topfolder namen komen namelijk terug op de Word documenten en Catia tekeningenkaders. De benaming van de Topfolder begint met een hoofdletter. Top Folder kan maximaal 40 karakters zijn i.v.m. met de ruimte in het tekeningenkader. Eenmaal aangemaakt mogen Topfolder namen nooit gewijzigd worden! 4

5 Nummering Ieder document heeft in SmarTeam twee nummers: 1. Item-nummer 2. Nikhef-nummer 1. Item-nummer Eén zelfde Item-nummer kan aan meerdere documenten worden vergeven om documenten aan elkaar te koppellen. Het Item-nummer is opgebouwd uit twee letters en een vier cijfers. Voorbeeld: AA0358 Het Item-nummer kan automatisch (opeenvolgend) worden gegenereerd met een hiervoor aangebrachte knop [Next Id] naast het invulveld. Indien het Item-nummer veld leeg wordt gelaten is het niet mogelijk te saven in SmarTeam. Er wordt niet gecontroleerd of het nummer al bestaat. Indien bekend is met welk ander document het te saven document gekoppeld moet worden, kan het al bestaande Item-nummer, van het document waar aan gekoppeld moet worden, met de hand worden ingevuld. Met een zoekopdracht op het Item-nummer kunnen alle documenten die met elkaar te maken hebben worden gevonden. 5

6 2. Nikhef-nummer Het Nikhef-nummer is kan aan maar één document worden vergeven. Het Nikhef-nummer is samengesteld uit het volgende: o Programma-nummer 38 (ATLAS) o Project-nummer 640 (ID upgrade pixel detectors) o Afdelings-letters ME (Mechanical Engineering) o Volgnummer (5 cijfers) Voorbeeld: ME Het Nikhef-nummer hangt dus af van in het: Programma, Project en Afdeling, waar het document wordt opgeslagen. Het Nikhef-nummer wordt automatisch gegenereerd tijdens het opslaan in SmarTeam en is dus afhankelijk van waar in de projectstructuur het document wordt opgeslagen. Met een zoekopdracht op het Nikhef nummer kan specifiek het betreffende document worden gevonden. 6

7 Voorbeelden van nummering 7