+ All Categories
Home > Documents > BSP 0100 BspProjektHandbuch - pmcm.frox.compmcm.frox.com/BSP_0100.pdf · BSP Projekthandbuch...

BSP 0100 BspProjektHandbuch - pmcm.frox.compmcm.frox.com/BSP_0100.pdf · BSP Projekthandbuch...

Date post: 06-Mar-2018
Category:
Upload: truongnhi
View: 218 times
Download: 0 times
Share this document with a friend
28
© FROX communication, CH-8634 Hombrechtikon BSP Projekthandbuch Dokument: BSP_0100 Autor: Robert Kolb FROX communication +41 55 254 12 54 Mitautor(en): Klassifikation: Restricted Edition: 0.1 / 16.02.2005 Gedruckt: 10.04.05 18,00 Gespeichert unter: BSP_0100_BspProjektHandbuch.doc CC:
Transcript

© FR OX commun i c a t i on , CH- 8634 Homb rec h t i ko n

BSP Projekthandbuch

Dokument: BSP_0100

Autor: Robert Kolb FROX communication +41 55 254 12 54 Mitautor(en): Klassifikation: Restricted Edition: 0.1 / 16.02.2005 Gedruckt: 10.04.05 18,00 Gespeichert unter: BSP_0100_BspProjektHandbuch.doc CC:

BSP Projekthandbuch Einleitung

Dok. BSP_0100 Edition 0.1 / 16.02.2005 Seite 2 von 28

Inhalt

Inhalt.............................................................................................................................................. 2 Abbildungen................................................................................................................................... 3 Tabellen......................................................................................................................................... 3 Änderungskontrolle........................................................................................................................ 4 1. Einleitung ............................................................................................................................... 5

1.1 Übersicht, Geltungsbereich.......................................................................................... 5 1.2 Abkürzungen................................................................................................................ 5 1.3 Referenzen .................................................................................................................. 5

2. Projektbeschreibung .............................................................................................................. 6 2.1 Ausgangssituation........................................................................................................ 6 2.2 Projektauftrag............................................................................................................... 6

2.2.1 Systemgrenzen ............................................................................................... 6 2.2.2 Schnittstellen ................................................................................................... 7 2.2.3 Rahmenbedingungen ...................................................................................... 7

2.3 Projektziele .................................................................................................................. 7 2.3.1 Mussziele ........................................................................................................ 7 2.3.2 Sollziele........................................................................................................... 7 2.3.3 Kannziele......................................................................................................... 7 2.3.4 Nichtziele......................................................................................................... 7

2.4 Liefergegenstand ......................................................................................................... 8 2.5 Vorgehensstrategie ...................................................................................................... 8

3. Projektspezifisches Vorgehensmodell.................................................................................... 9 4. Meilensteine und auszuliefernde Ergebnisse ....................................................................... 10

4.1 Terminplan ................................................................................................................. 10 4.2 Detailterminplan ......................................................................................................... 10

5. Methoden und Werkzeuge ................................................................................................... 11 5.1 Methoden................................................................................................................... 11 5.2 Werkzeuge................................................................................................................. 11 5.3 Infrastructure.............................................................................................................. 11

5.3.1 Personal Computer........................................................................................ 11 5.3.2 Unix Workstations.......................................................................................... 11

6. Organisatorischer Rahmen .................................................................................................. 12 6.1 Projektorganisation (Kurzbeschreibung) .................................................................... 12 6.2 Organisationsdiagramm ............................................................................................. 12 6.3 Aufgaben und Verantwortlichkeiten............................................................................ 12

6.3.1 Vertreter des Auftraggebers .......................................................................... 12 6.3.2 Projektleitung................................................................................................. 12 6.3.3 Projektteam ................................................................................................... 13

6.4 Informationskonzept................................................................................................... 13 6.4.1 Besprechungsstruktur.................................................................................... 13 6.4.2 Meetings within the Project............................................................................ 13

6.4.2.1 External Project Meeting (EPM) ..................................................... 13 6.4.2.2 Internal Project Meeting (IPM)........................................................ 14 6.4.2.3 Workshop (WS) .............................................................................. 14

6.4.3 Kommunikation und Reporting ...................................................................... 15 6.4.3.1 Verwaltung von Kontaktinformationen ............................................ 15 6.4.3.2 Eingesetzte Kommunikationsmittel und Verschlüsselung............... 15 6.4.3.3 Berichtswesen und Reporting......................................................... 15 6.4.3.4 Leistungserfassung ........................................................................ 15

BSP Projekthandbuch Einleitung

Dok. BSP_0100 Edition 0.1 / 16.02.2005 Seite 3 von 28

7. Standards und Richtlinien .................................................................................................... 16 7.1 Verwendete Standards, Werkzeuge und Richtlinien .................................................. 16 7.2 Verwendete Vorlagen................................................................................................. 16 7.3 Documentation........................................................................................................... 16

7.3.1 General Aspects............................................................................................ 16 7.3.1.1 Development Documentation ......................................................... 17 7.3.1.2 User Documentation....................................................................... 17

7.3.2 Memos .......................................................................................................... 17 7.3.3 Documentation Guidelines............................................................................. 18 7.3.4 Hints for the Work and Configuration of Winword .......................................... 18 7.3.5 Document Templates for Winword................................................................. 19

7.3.5.1 Using the Document Template BSP_DOC_english ........................ 19 7.3.5.2 Using the Memo Template BSP_MEMO ........................................ 21

7.4 Aktenordnung und Ablage von Erzeugnissen............................................................. 22 7.4.1 Directory Structure......................................................................................... 22 7.4.2 Dokumentenmanagement und Kennzeichnung ............................................. 22

7.4.2.1 Dokumentenstati ............................................................................ 22 7.4.2.2 Dokumentenbezeichnung............................................................... 23

7.5 Konfigurationsmanagement ....................................................................................... 23 7.5.1 Program Code ............................................................................................... 23 7.5.2 Documents .................................................................................................... 23

7.5.2.1 User Working Folders..................................................................... 25 7.5.2.2 Setting Working Folders in VSS ..................................................... 26

7.6 Qualitätssicherung ..................................................................................................... 28

Abbildungen

Figure 2.1: Systemgrenzen des Projekts CIS ................................................................................ 6 Figure 7.1: BSP directory structure on Fileserver EARTH ........................................................... 22 Figure 7.2: Location of read-only documents for project BSP on NT-Server EARTH................... 24 Figure 7.3: User working folder.................................................................................................... 25 Figure 7.4: Select subproject to set working folder ...................................................................... 26 Figure 7.5: Open File Menu to set working folder ........................................................................ 27 Figure 7.6: Dialog to set working folder........................................................................................ 27 Figure 7.7: Working folder is displayed above files list................................................................. 28

Tabellen

Table 7.1: Styles in template BSP_DOC .................................................................................. 20 Table 7.2: Styles in template BSP_MEMO ............................................................................... 21

BSP Projekthandbuch Einleitung

Dok. BSP_0100 Edition 0.1 / 16.02.2005 Seite 4 von 28

Änderungskontrolle

Datum Edition Visum Bemerkungen 16.02.2005 0.1 RK Erster Entwurf

BSP Projekthandbuch Einleitung

Dok. BSP_0100 Edition 0.1 / 16.02.2005 Seite 5 von 28

1. Einleitung

1.1 Übersicht, Geltungsbereich

Das Projekt Handbuch beschreibt, wie die Arbeit im Projekt organisiert ist. Es definiert die Werk-zeuge und Methoden sowie die Umgebung in welcher das Projekt abgewickelt wird. Die verwen-deten Werkzeuge werden in Form eines Betriebshandbuchs beschrieben. Der Hauptzweck dieses Dokuments besteht darin, die Projektarbeit zu erleichtern sowie die Pro-duktivität und Qualität zu steigern. Aus diesem Grund sollen die im Dokument enthaltenen Vor-gaben nicht primär als willkürliche Einschränkung der persönlichen Freiheiten verstanden wer-den. Die im vorliegenden Dokument definierten Regeln gelten für alle Projektmitglieder, Ausnahmen werden explizit erwähnt.

1.2 Abkürzungen

1.3 Referenzen

BSP Projekthandbuch Projektbeschreibung

Dok. BSP_0100 Edition 0.1 / 16.02.2005 Seite 6 von 28

2. Projektbeschreibung

2.1 Ausgangssituation

Die Beispiel AG betreibt für ihre Kunden ein landesweites Netzwerk und Einrichtungen zur Ver-breitung von Information. Bei Störungen im Netzwerk und bei den Einrichtungen werden Service Techniker der Beispiel AG in den betroffenen Regionen aufgeboten und zentral koordiniert. Heute existiert bei einem Störungsfall ein reger Austausch über Telefon und Email zwischen al-len beteiligten Stellen. Dieser unkoordinierte Austausch an Informationen wird von den meisten Beteiligten als unbefriedigend eingeschätzt, weil nicht immer alle über den vollständigen oder ak-tuellen Stand der Störungsbehebung informiert sind. Die Kunden der Beispiel AG haben schon verschiedentlich den Wunsch geäussert, besser über den Störungsbehebungsfortschritt und -ablauf informiert zu werden. Sie wünschen sich eine on-line Darstellung der pendenten Störungen.

2.2 Projektauftrag

Aufgund der unbefriedigenden Situation im Störungsbehebungsprozess und unter dem Erwar-tungsdruck der Kunden hat sich die GL der Beispiel AG entschieden, das Projekt CIS (Customer Information and Support) zu starten und die Firma FROX communication mit der Umsetzung zu beauftragen. Grundsätzlich geht es darum, die unkoordinierten Emails durch ein modernes Trouble Ticketing System abzulösen. Das neue System soll auch als Plattform für die Kommunikation mit den Kun-den verwendet werden können.

2.2.1 Systemgrenzen Das Projekt CIS umfasst die internen und die externen Kommunikationwege und -mittel zu den Kunden der Beispiel AG, die Anbindung zu den Managementsystemen des Netzwerkes und der Einrichtungen sowie die Anbindungen an die Datenbanken (Inventar und Dispatching).

NEMS

Netzwerke Datenbanken

Kunde (SLA) Work Flow

SPOC

Inventar DB Dispatching DB

KundenschnittstelleSprache Web

CIS

NEMS

Figure 2.1: Systemgrenzen des Projekts CIS

BSP Projekthandbuch Projektbeschreibung

Dok. BSP_0100 Edition 0.1 / 16.02.2005 Seite 7 von 28

2.2.2 Schnittstellen Die Schnittstellen des Projekts CIS sind:

• Kommunikationsschnittstelle zum Kunden über Web • Datenschnittstelle zu den Managementsystemen des Netzwerks bzw. den Einrichtungen • Datenschnittstelle zur Inventar Datenbank (Oracle) • Datenschnittstelle zur Dispatching Datenbank (Einsatzplanung der Service Techniker)

2.2.3 Rahmenbedingungen Das Trouble Ticketing System soll von allen Mitarbeitern (ca.300) der Beispiel AG genutzt wer-den können. Es wird erwartet, dass etwa 30 Kunden gleichzeitig am System angemeldet sein werden.

2.3 Projektziele

2.3.1 Mussziele Das Trouble Ticketing System muss das parallele Arbeiten an einer Störung unterstützen, d.h. eine Störung muss in zu lösende Teilprobleme aufgeteilt werden können, welche anschliessend an verschiedene Gruppen zugewiesen werden. Zuweisungen von Tickets (Arbeitsaufträge) müssen mit automatischen Benachrichtigungen (z.B. Email, SMS oder Pager) verbunden werden können. Die Web-Schnittstelle zu den Kunden muss für die Web-Browser Internet Explorer 5.5 und höher sowie Firefox 1.0 und höher die volle Funktionalität umfassen und darf sich in der Bedienung nicht unterscheiden. Das Trouble Ticketing System muss so ausgelegt sein, dass jährlich mindestens 5000 Störungs-fälle verarbeitet werden können.

2.3.2 Sollziele Neben den Störungsfällen sollen auch geplante Unterbrücke oder periodische Wartungsarbeiten im Trouble Ticketing System erfasst werden können.

2.3.3 Kannziele Die Benutzer des Trouble Ticketing System sollen im zentralen User Directory (LDAP) verwaltet werden.

2.3.4 Nichtziele Obwohl bereits eine Oracle Datenbank für die Inventar Daten im Einsatz steht, soll diese nicht für das Trouble Ticketing System verwendet werden.

BSP Projekthandbuch Projektbeschreibung

Dok. BSP_0100 Edition 0.1 / 16.02.2005 Seite 8 von 28

2.4 Liefergegenstand

Das Projekt CIS wird als Turn-key Solution geliefert und besteht aus folgenden Komponenten: Hardware:

• 2 Server, einer für das Intranet und einer für die Kommunikation mit den Kunden über In-ternet.

Software

• Betriebssysteme für die Server Hardware • Oracle Datenbank inkl. erforderliche Anzahl Lizenzen • ARS Applikationsserver inkl. erforderliche Anzahl Lizenzen • ARS Client Software (inkl. Installation auf 3 Arbeitsplätzen für Pilotbetrieb) • CIS Applikation (inkl. Schnittstellen zu den Managementsystemen und externen Daten-

banken) Dokumentation

• Dokumentation für Kunden, Service Techniker und Administratoren. Die spezifische Be-nutzerdokumentation für Kunden und Service Techniker ist in Deutsch, die Administrati-onsdokumentation und die Manuals für die Betriebssystene, Datenbanken und ARS sind in Englisch.

2.5 Vorgehensstrategie

Das es sich beim Projekt CIS für die Beispiel AG um einen Auftrag handelt, welcher in ähnlicher Form schon mehrmals realisiert wurde und deshalb relativ gut abgeschätzt werden kann, wird ei-ne klassische Vorgehensstrategie (Wasserfall) gewählt.

BSP Projekthandbuch Projektspezifisches Vorgehensmodell

Dok. BSP_0100 Edition 0.1 / 16.02.2005 Seite 9 von 28

3. Projektspezifisches Vorgehensmodell

1. Spezifikation (Anpassungen gegenüber Standardprodukt, Schnittstellen) 2. Design 3. Implementation 4. Test 5. Schulung 6. Inbetriebnahme 7. Pilotbetrieb 8. Schlussanpassungen und Fehlerbehebungen 9. Abnahme 10. Produktivbetrieb

BSP Projekthandbuch Meilensteine und auszuliefernde Ergebnisse

Dok. BSP_0100 Edition 0.1 / 16.02.2005 Seite 10 von 28

4. Meilensteine und auszuliefernde Ergebnisse

4.1 Terminplan

01.02.2005 Kick-off mit Projektleitung der Beispiel AG

15.02.2005 Beginn der Spezifikationspase (erster Workshop mit Beispiel AG)

05.04.2005 Abgabe Spezifikation zur Review bei Beispiel AG

20.04.2005 Freigabe der Spezifikation für Implementation

30.06.2005 Start Schulung für Administratoren und Endbenutzer während Pilotbetrieb

25.06.2005 Start Inbetriebnahme

29.06.2005 Bereit für Pilotbetrieb

01.08.2005 Start Pilotbetrieb

29.08.2005 Abnahme

05.09.2005 Beginn Produktivbetrieb

4.2 Detailterminplan

siehe Detailterminplan gemäss Dokument BSP_0110_DetailTerminplan.mpp

BSP Projekthandbuch Methoden und Werkzeuge

Dok. BSP_0100 Edition 0.1 / 16.02.2005 Seite 11 von 28

5. Methoden und Werkzeuge

5.1 Methoden

Verwendet werden "Stukturierte Analyse und Design"

5.2 Werkzeuge

Nr. Aktivität Werkzeug Version 1. Terminplanung MS Project 98 2. Dokumentation und Memos MS Word Office97 3. 4. 5. 6. 7. 8.

(Aktivität: z.B. Terminplanung; Werkzeug: z.B: MS Project, Version: z.B. 2003.)

5.3 Infrastructure

5.3.1 Personal Computer The project members have all access to a PC that's connected to the LAN. The access to the project relevant data is possible by means of the Q-Drive for technical issues and on the NT-Server EARTH by means of the shared directory \\EARTH\Projekte\CIS. The templates for Winword documents are located under \\Earth\FROX\Templates\Word\Entwicklung.

5.3.2 Unix Workstations

All Unix workstations are interconnected with the server of the LAN.

BSP Projekthandbuch Organisatorischer Rahmen

Dok. BSP_0100 Edition 0.1 / 16.02.2005 Seite 12 von 28

6. Organisatorischer Rahmen

6.1 Projektorganisation (Kurzbeschreibung)

Für die Abwicklung des Projekts wird ein Projektteam gebildet, das während der ganzen Projekt-dauer besteht. Die geplante Auslastung für Arbeiten in Zusammenhang mit diesem Projekt be-trägt 80% der normalen Arbeitszeit der Projektmitarbeiter.

6.2 Organisationsdiagramm

Kommerzieller ProjektleiterHans Frank

ARS ServerFritz Meier

WorkflowThomas Hierlang

Web InfrastructureStefan Net

Web GUIsPeter Window

CIS InfrastructureKlaus Intern

InterfacesJo Dazwischen

Technischer ProjektleiterGuido Work

AuftraggeberBeispiel AG

6.3 Aufgaben und Verantwortlichkeiten

6.3.1 Vertreter des Auftraggebers

Aufgabe / Rolle Name Abt./Firma E-Mail Telefon Projektleiter Marcel Boss Beispiel AG [email protected] 1122345 Einkauf Albert Kauf Beispiel AG [email protected] 1122344 IT Verantwortlicher James Oracle Beispiel IT AG [email protected] 1122333

6.3.2 Projektleitung

Aufgabe / Rolle Name Abt./Firma E-Mail Telefon Technischer Projektleiter Guido Work [email protected] 11 Kommerzieller Projektleiter Hans Frank [email protected] 12

BSP Projekthandbuch Organisatorischer Rahmen

Dok. BSP_0100 Edition 0.1 / 16.02.2005 Seite 13 von 28

Aufgabe / Rolle Name Abt./Firma E-Mail Telefon Verantw. Qualitätssicherung Guido Work [email protected] 11

6.3.3 Projektteam

Aufgabe / Rolle Name Abt./Firma E-Mail Telefon ARS Server Fritz Meier [email protected] 22 Workflow Thomas Hierlang [email protected] 23 Web Infrastructure Stefan Net [email protected] 24 Web GUIs Peter Window [email protected] 26 CIS Infrastructure Klaus Intern [email protected] 28 Interfaces Jo Dazwischen [email protected] 21

6.4 Informationskonzept

6.4.1 Besprechungsstruktur

Besprechnungszyklus Besprechungsart

wöchentlich monatlich Datum bei Bedarf Teilnehmer

IPM X Montags 0900 TPL, Projektteam EPM X 1. Woche des

Montats TPL, Auftraggeber

PL Meeting X TPL, KPL

6.4.2 Meetings within the Project The coordination within the project will be done on the base of three different kinds of meetings. These meetings and the participants are described in the following.

6.4.2.1 External Project Meeting (EPM)

The main goal of the External Project Meetings (EPM) is the coordination (schedule, functionality) between the customer and FROX. Occurrence: • regularly • once a month

BSP Projekthandbuch Organisatorischer Rahmen

Dok. BSP_0100 Edition 0.1 / 16.02.2005 Seite 14 von 28

The EPM will take place once a month. The participants of these meetings are: • Project manager FROX (leader) • Project manager customer • Additional persons from customer as required • Additional persons from FROX Standard Agenda for EPM: • Project status • Actual problems and questions • Specification reviews • Open issues, next steps • Dates All decisions made in the EPM must be recorded in a protocol. Use Winword template BSP_extern_PROT.dot.

6.4.2.2 Internal Project Meeting (IPM)

The main purpose of the Internal Project Meetings (IPM) is the coordination between the project manager and the Developers. All decisions with an impact on time and costs must be discussed in this forum. Occurrence: • regularly • once a week The participants of these meetings are: • FROX (leader) • Project members as required Standard Agenda for IPM: • Project status • Actual problems and questions • Specification reviews • Open issues, next steps • Dates All decisions made in the IPM must be recorded in a protocol. Use Winword template BSP_intern_PROT.dot.

6.4.2.3 Workshop (WS)

The workshop meetings are held to discuss technical problems, i.e. to work for a concept or a de-tailed solution. Occurrence: • spontaneous • on demand Participants: • Project manager FROX (usually as leader) • Project members as appropriate due to their know how and job. • External persons as appropriate The output of a workshop shall be documented in a memo, a concept paper or a specification.

BSP Projekthandbuch Organisatorischer Rahmen

Dok. BSP_0100 Edition 0.1 / 16.02.2005 Seite 15 von 28

6.4.3 Kommunikation und Reporting

6.4.3.1 Verwaltung von Kontaktinformationen

Der technische Projektleiter verwaltet die Adressen und Kontaktinformationen der am Projekt be-teiligten Personen.

6.4.3.2 Eingesetzte Kommunikationsmittel und Verschlüsselung

Für die Kommunikation sind folgende Mittel vorgesehen: • Email • Fax • Telefon

Die Kommunikation erfolgt unverschlüsselt

6.4.3.3 Berichtswesen und Reporting

Inhalt/Form Verantwortlich Empfänger Intervall Statusbericht intern TPL GL monatlich Statusbericht extern TPL Auftraggeber, cc KPL monatlich

6.4.3.4 Leistungserfassung

Die Projektmitglieder erfassen die aufgelaufenen Aufwände und Auslagen mindestens wöchent-lich im Leistungserfassungs-Tool.

BSP Projekthandbuch Standards und Richtlinien

Dok. BSP_0100 Edition 0.1 / 16.02.2005 Seite 16 von 28

7. Standards und Richtlinien

7.1 Verwendete Standards, Werkzeuge und Richtlinien

Aktivität / Produkt Standards / Werkzeuge / Richtlinien

7.2 Verwendete Vorlagen

Aktivität / Produkt Vorlagen Beschlussfassung Beschlussliste Review Reviewprotokoll

7.3 Documentation

7.3.1 General Aspects The development documentation must be written in English, whereas training documents, proto-cols and memos should be written in German. User documentation should be written in English but can also be written in German according to customer requirements. The documentation is divided in 3 categories. • Development documentation • System documentation • User documentation

BSP Projekthandbuch Standards und Richtlinien

Dok. BSP_0100 Edition 0.1 / 16.02.2005 Seite 17 von 28

7.3.1.1 Development Documentation

The development documentation is primarily for internal use with the exception of acceptance documents and consists of: • Concepts • Specifications • Design and Implementation descriptions • Test specifications and reports • Acceptance specifications and reports The specifications are primarily internal documents but might be created in co-operation with the customer. In this case they may be handed out to the customer.

7.3.1.2 User Documentation

The user documentation consists of: • Installation Guide • Configuration Guide • Operating Guide for Uses • Operating Guide for Administrators • Training Guides The user documentation will be distributed in electronically form only, i.e. no hard copies. The distribution media and format has to be defined.

7.3.2 Memos Memos are used for internal communication (e.g. minutes of meetings etc.). For that purpose, a Winword template [BSP_MEMO.dot] exists. Memos are numbered consequently as follows: BSP_M000 … BSP_M999 At Memos are handled as follows: • All memos are stored on the server in the directory Q:\Projekte\CIS\Doku\Memos • To write a new memo, the first step is to select the next free number by incrementing the

highest memo number found in the document Q:\Projekte\CIS\Doku\Memos\BSP_memdir.doc. Second step is to allocate the memo number by adding at least the title and the author of the memo in the row of the se-lected memo number in the document Q:\Projekte\CIS\Doku\Memos\BSP_memdir.doc. Then the new document has to be created on the basis of the template BSP_MEMO.dot and to be stored in the directory Q:\Projekte\CIS\Doku\Memos.

• To avoid a badly arranged directory, a subdirectory should be made for every 30 memos. For example when there are 32 memos in the directory Q:\Projekte\CIS\Doku\Memos beginning with memo number 030 then a subdirectory with the name M030_059 should be created and the memos BSP_M030.doc until BSP_M059.doc should be moved into the new subdirectory.

BSP Projekthandbuch Standards und Richtlinien

Dok. BSP_0100 Edition 0.1 / 16.02.2005 Seite 18 von 28

7.3.3 Documentation Guidelines The following guidelines are applicable to all documents: • All documents must be written in English, exceptions are stated. • The standard font is Arial. • For documents a font size of 10 points should be used. • The templates supplied by the project manager must not be altered by the project mem-

bers. If you have any suggestions for their improvement, please contact the technical pro-ject manager.

7.3.4 Hints for the Work and Configuration of Winword The following hints for the configuration and the work with Word (97) may help you with your daily work for documentation: • Set Tools->Options->View: Field shading to 'always'. -> All text that is generated by a

field (e.g. cross-references, table of contents, etc.) is displayed with a gray background. Do never replace such text.

• Deactivate Tools->Options->Save: Allow fast saves. -> If you allow fast saves, the changes to a document are appended at its end and the document grows and grows.

• Activate Tools->Options->Save: Prompt for document properties. -> If you save a document the first time, the summary window automatically opens. Most templates work with the information in the document summary.

• Activate Tools->Options->Save: Prompt to save Normal.dot. -> If you have made any changes to the configuration (e.g. key assignment, changes on macro) this will be stored in Normal.dot. With this option you are asked whether the changes shall be stored or not. If you made some (temporary) changes, you are able to prevent Winword from saving by that.

• Insert in Tools->Options->File Locations: Workgroup Templates the path to your tem-plates. \\EARTH\FROX\Templates\Word

• Insert in Tools->Options->User Information your name. − Customize the toolbars. E.g. replace the NEW button (command FileNewDefault) by a

button with the command FileNew or replace the PRINT button (command FilePrintDe-fault) by a button for FilePrint.

• Assign often-used styles to shortcut keys, e.g. the List Bullet to ALT-B. (The experience has shown that it is best to assign your 'private' keys to ALT-Keys.) − Open Format->Style − Select the style to be assigned to a shortcut − Select Modify->Shortcut Key − In the current keys field, the already assigned key combination are displayed − Type your shortcut into the Field 'new shortcut'. Below that field you get displayed what

is currently assigned to that key. Check whether or not this can be changed. • Do not use manual page brakes (CTRL-Enter) within a document if the automatic page

brake occurs at a position you don't want, e.g. after the first few lines of a section. Instead of that: − Select the text to be shifted to the new page − Open Format->Paragraph->Text Flow − Activate Keep with next and Keep lines together. -> The automatic page brake mo-

ves up. • Record macros and assign them to a key to facilitate your work. E.g. assign the procedure

describe above to ALT-K. • Do not use Tabs to format text in columns. The experience has shown that it is more ap-

propriate to use a table. Tables have the advantage, that inside any cell the text is format-ted automatically (left and right borders).

BSP Projekthandbuch Standards und Richtlinien

Dok. BSP_0100 Edition 0.1 / 16.02.2005 Seite 19 von 28

7.3.5 Document Templates for Winword In the following sections the Winword templates are described. These templates are stored on the NT-Server EARTH: \\EARTH\FROX\Templates\Word. The templates should not be altered by any project member. If you have any suggestions for their improvement, please contact the technical project manager. For an easy access to the templates it is recommended to define the path in the Winword Opti-ons (Tools command, ‘Workgroup templates’ in the ‘File Locations tab’).

7.3.5.1 Using the Document Template BSP_DOC_english

How to start a new document based on BSP_DOC_english.dot

Some information in a document basing on the BSP_DOC_english template must be entered in the File->Properties->Summary window. The information is then automatically inserted into the predefined locations. Out of that the following procedure is recommended if a new document is made: • Create a new document with File->New and select BSP_DOC_english from the list (re-

spectively press the according button if you have assigned the FileNew command to any; see also section 7.3.4)

• Save the document • The Properties / Summary window pops up if you have configured

Tools->Options->Save: Prompt for document properties as described in section 7.3.4. • Insert the document title in the Title field. • Replace the xxxx in the keywords filed by the document number. • Close the window by means of OK. • To update your document press CTRL+A (select all) and F9 (update fields). • Start writing the document.

Possible problems with documents based on BSP_DOC_english

The edition string in the footer is not complete (e.g. Edition 1.0 / 01. instead of 01.04.1999): • This string is taken from the title page. Do not try to correct this problem in the footer itself! • Go to the title page • Activate in Tools-> Options->View->Show the bookmarks box. • Now you can see that the Edition-String is not completely in brackets '[' ']' (e.g. [1.0 /

01.]04.1999) • Correct the string. Hint: You can not enter any character after the last character within

brackets (bug?). Therefore insert the characters after the second-last character and delete the last character if it is wrong.

The document title, document id, author etc. are not correct: • You might not have updated the document -> press CTRL-A (select all) and F9 (update

fields).

• You have not entered the according information in the document properties/summary, pro-bably because you have not activated the option to get prompted therefor if the document is saved (see section 7.3.4). − To enter the information choose File->Properties->Summary and enter it in the ac-

cording fields.

BSP Projekthandbuch Standards und Richtlinien

Dok. BSP_0100 Edition 0.1 / 16.02.2005 Seite 20 von 28

Template for documents

Template name: BSP_DOC_english Used for: documents listed in the document status list [BSP_0105] Styles in the template (listed alphabetically):

Style name Short cut key

Style description for ge-neral use

Caption style of captions for tables and figures; caption text is inserted automatically into the Table of figures

DocId style of the document identification on the title page Doctitle style of the document title on the title page Footer style for the footer Footer1 style of the footer on the first page FooterL, FooterC, FooterR

styles of the Left-, Center-, Right-Part of the footer of pages 2…n

grafic ALT+G used for figures and tables; includes space before and keeps next line (Caption) on the same page

Yes

grafic big same as grafic but beginning on left border without indent Yes Header style for the header Header1, Header2, Header3

used in the document headers only

Heading 1…9

ALT+1 … ALT+5

Heading for level 1…9, but only level 1…4 should be used. Heading text is inserted automatically into the Table of con-tents. Before Heading 1 a page break is inserted automatically.

Yes

Indent ALT+I Hanging indent of text by 1 cm Yes List 1 ALT+L List with bullets, level 1 (bold style); following style List 2 Yes List 2 ALT+; - list with hyphens, level 2 Yes List bullet ALT+B List with bullets (normal style) Yes Normal ALT+N Standard style for all text Yes Title 1 no page break

Same as ‘Heading 1’ but not numbered and no page break before. Used for title of ‘Table of figures’ and ‘History’. May be replaced by ‘Title 1 not numbered’ if the tables don’t fit on one single page

Title 1 not numbered

Same as ‘Heading 1’ but not numbered. May replace ‘Title 1 no page break’ if the ‘Table of contents’, ‘Table of figures’ and ‘History’ do not fit on one single page.

(Yes)

TOC 1…9 Styles for Table of contents.

Table 7.1: Styles in template BSP_DOC

In the last column of Table 7.1 the styles for general use are marked with ‘Yes’. The other styles should not be used throughout the document.

BSP Projekthandbuch Standards und Richtlinien

Dok. BSP_0100 Edition 0.1 / 16.02.2005 Seite 21 von 28

7.3.5.2 Using the Memo Template BSP_MEMO

How to start a new memo based on BSP_MEMO

Some information in a document basing on the BSP_MEMO template must be entered in the File->Properties->Summary window. The information is then automatically inserted into the pre-defined locations. Out of that the following procedure is recommended if a new document is be-gun: • Create a new document with File->New and select BSP_MEMO from the list (respectively

press the according button if you have assigned the FileNew command to any; see also section 7.3.4)

• Save the document to Q:\MEMOS and choose the next free number • The properties / summary window pops up if you have configured

Tools->Options->Save: Prompt for document properties as described in section 7.3.4. • Insert the memo subject in the Title field. • Replace the xxx in the keywords filed by the memo number. • Close the window by means of OK. • To update your document press CTRL+A (select all) and F9 (update fields). • Start writing the memo.

Possible problems with documents based on BSP_MEMO

See section 0.

Template for BSP memos

Template name: BSP_MEMO Used for: memos (e.g. minutes of meeting)

Style name Short cut key

Style description for ge-neral use

Caption style of captions for tables and figures; caption text is inserted automatically into the Table of figures

Footer, Footer1

style for the footer

Header, Header2

style for the header

Heading 1…9

ALT+1 … ALT+5

Heading for level 1…9, but only level 1…4 should be used. Yes

Indent ALT+I Hanging indent of text by 1 cm Yes List 1 ALT+L • List with bullets, level 1 (bold style); following style

List 2 Yes

List 2 ALT+; - list with hyphens, level 2 Yes List bullet ALT+B • List with bullets (normal style) Yes Normal ALT+N Standard style for all text Yes Title Title row of Memo

Table 7.2: Styles in template BSP_MEMO

In the last column of Table 7.2 the styles for general use are marked with ‘Yes’. The other styles should not be used throughout the document.

BSP Projekthandbuch Standards und Richtlinien

Dok. BSP_0100 Edition 0.1 / 16.02.2005 Seite 22 von 28

7.4 Aktenordnung und Ablage von Erzeugnissen

7.4.1 Directory Structure The table below describes the directory structure on the Fileserver EARTH. This description does not pretend to be complete. It shows the major branches of the directory tree.

Figure 7.1: BSP directory structure on Fileserver EARTH

7.4.2 Dokumentenmanagement und Kennzeichnung

7.4.2.1 Dokumentenstati

Status Comment planned Dieses Dokument ist geplant edit Dieses Dokument wird zur Zeit bearbeitet review Dieses Dokument ist beim Auftraggeber zur Review in revision Dieses Dokument ist intern zur Review released Dieses Dokument wurde für internen Gebrauch oder Kunden freigegebenacceptance Dieses Dokument ist für die Acceptance relevant revised Dieses Dokument wurde überarbeitet closed Dieses Dokument wird nicht mehr nachgeführt

BSP Projekthandbuch Standards und Richtlinien

Dok. BSP_0100 Edition 0.1 / 16.02.2005 Seite 23 von 28

7.4.2.2 Dokumentenbezeichnung

Die Dokumente werden durch eine Projektabkürzung (z.B. BSP_), eine vierstellige Dokumenten-nummer und ein abgekürzter Dokumenttitel gekennzeichnet. Beispiel: BSP_8600_IGOverview Der technische Projektleiter vergibt die Dokumentennummern anhand des folgenden Schemas: Bereich Bedeutung 0000 - 0999 Projekt Dokumente 1000 - 1999 System Dokumente 2000 - 2999 Database Applikationen 3000 - 3999 Core Applikationen 4000 - 4999 Web Applikationen 5000 - 5999 Workflow Applikationen 6000 - 6999 Interface Applikationen 7000 - 7999 Schulungs Dokumentation 8000 - 8999 User Dokumentation (Install, User, Admin Guides) 9000 - 9999 reserved

Unterbereich Bedeutung x000 - x099 Subprojekt Dokumentation (Organisation, …) x100 - x199 Konzepte (x100: Allgemeines Konzept) x200 - x299 Spezifikationen (Requirements, Interface Specifications, …) x300 - x399 Design und Implementation Dokumente x400 - x499 Test Dokumente x500 - x599 Acceptance Dokumente x600 - x699 Installations Dokumente x700 - x799 Konfigurations Dokumente x800 - x899 Operation Dokumente x900 - x999 reserved

7.5 Konfigurationsmanagement

All software units (documents and program modules) are stored on the File Server EARTH. The data on this server is backuped daily. Appropriate tools must be used to allow an efficient configuration management.

7.5.1 Program Code The tools for the management of the source code have been defined to be Subversion or at least CVS for Source Code developed on Unix platforms. An option is to use MS Visual Source Safe 6.0 for Source Code developed on PC Platforms (e.g. ARS) as it used for the documents.

7.5.2 Documents The documents are managed by means of MS Visual Source Safe 6.0. The project members are allowed to check in and check out existing documents. New documents have to be approved by the project leader in order to maintain a consistent document numbering system.

BSP Projekthandbuch Standards und Richtlinien

Dok. BSP_0100 Edition 0.1 / 16.02.2005 Seite 24 von 28

A read-only copy of every document stored in VSS is stored in \\EARTH\Projekte\CIS\Doku\Dokumente\Docs to facilitate the quick access to the docu-ments for informational purposes. Documents in this directory may not be altered because they will be overwritten each time a new revision is checked in. These directories are called “shadow folders” because they reflect the newest revisions of each document stored in VSS.

Figure 7.2: Location of read-only documents for project BSP on NT-Server EARTH

BSP Projekthandbuch Standards und Richtlinien

Dok. BSP_0100 Edition 0.1 / 16.02.2005 Seite 25 von 28

7.5.2.1 User Working Folders

Each project member has its own working folder to create and modify project documents. This folder is defined to be \\EARTH\Projekte\CIS\Doku\Dokumente\Users\<username> as shown in the following figure. Documents may not be created and modified in the users Home or local folders.

Figure 7.3: User working folder

BSP Projekthandbuch Standards und Richtlinien

Dok. BSP_0100 Edition 0.1 / 16.02.2005 Seite 26 von 28

7.5.2.2 Setting Working Folders in VSS

Each project member has its own VSS login and must assign the working folder to create and modify project documents. This configuration must be done within the VSS application as follows:

Figure 7.4: Select subproject to set working folder

BSP Projekthandbuch Standards und Richtlinien

Dok. BSP_0100 Edition 0.1 / 16.02.2005 Seite 27 von 28

After the subproject is selected (e.g. 0xxx – Project) the dialog to set the working folder can be opened from the menu File->Set Working Folder…. See the following figure:

Figure 7.5: Open File Menu to set working folder

Then the following dialog appears. Enter here the working folder as defined \\EARTH\Projekte\CIS\Doku\Dokumente\Users\<username>. If the folder for this parti-cular user does not already exist, create the folder by pressing the “Create folder” button.

Figure 7.6: Dialog to set working folder

BSP Projekthandbuch Standards und Richtlinien

Dok. BSP_0100 Edition 0.1 / 16.02.2005 Seite 28 von 28

After the working folder for the subproject is defined, the working folder is displayed above the file list as shown in the following figure:

Figure 7.7: Working folder is displayed above files list Repeat the procedure for each subproject (e.g. 1xxx – System to 9xxx – Custom).

7.6 Qualitätssicherung

Organisation der Qualitätssicherung: tbd


Recommended