BSP Projekthandbuch. Autor: Robert Kolb FROX communication Mitautor(en):

Transkript

1 Dokument: BSP_0100 Autor: Robert Kolb FROX communication Mitautor(en): Klassifikation: Restricted Edition: 0.1 / Gedruckt: ,00 Gespeichert unter: BSP_0100_BspProjektHandbuch.doc CC: FROX communication, CH-8634 Hombrechtikon

2 Einleitung Inhalt Inhalt... 2 Abbildungen... 3 Tabellen... 3 Änderungskontrolle Einleitung Übersicht, Geltungsbereich Abkürzungen Referenzen Projektbeschreibung Ausgangssituation Projektauftrag Systemgrenzen Schnittstellen Rahmenbedingungen Projektziele Mussziele Sollziele Kannziele Nichtziele Liefergegenstand Vorgehensstrategie Projektspezifisches Vorgehensmodell Meilensteine und auszuliefernde Ergebnisse Terminplan Detailterminplan Methoden und Werkzeuge Methoden Werkzeuge Infrastructure Personal Computer Unix Workstations Organisatorischer Rahmen Projektorganisation (Kurzbeschreibung) Organisationsdiagramm Aufgaben und Verantwortlichkeiten Vertreter des Auftraggebers Projektleitung Projektteam Informationskonzept Besprechungsstruktur Meetings within the Project External Project Meeting (EPM) Internal Project Meeting (IPM) Workshop (WS) Kommunikation und Reporting Verwaltung von Kontaktinformationen Eingesetzte Kommunikationsmittel und Verschlüsselung Berichtswesen und Reporting Leistungserfassung Dok. BSP_0100 Edition 0.1 / Seite 2 von 28

3 Einleitung 7. Standards und Richtlinien Verwendete Standards, Werkzeuge und Richtlinien Verwendete Vorlagen Documentation General Aspects Development Documentation User Documentation Memos Documentation Guidelines Hints for the Work and Configuration of Winword Document Templates for Winword Using the Document Template BSP_DOC_english Using the Memo Template BSP_MEMO Aktenordnung und Ablage von Erzeugnissen Directory Structure Dokumentenmanagement und Kennzeichnung Dokumentenstati Dokumentenbezeichnung Konfigurationsmanagement Program Code Documents User Working Folders Setting Working Folders in VSS Qualitätssicherung Abbildungen Figure 2.1: Systemgrenzen des Projekts CIS... 6 Figure 7.1: BSP directory structure on Fileserver EARTH Figure 7.2: Location of read-only documents for project BSP on NT-Server EARTH Figure 7.3: User working folder Figure 7.4: Select subproject to set working folder Figure 7.5: Open File Menu to set working folder Figure 7.6: Dialog to set working folder...27 Figure 7.7: Working folder is displayed above files list Tabellen Table 7.1: Styles in template BSP_DOC Table 7.2: Styles in template BSP_MEMO Dok. BSP_0100 Edition 0.1 / Seite 3 von 28

4 Einleitung Änderungskontrolle Datum Edition Visum Bemerkungen RK Erster Entwurf Dok. BSP_0100 Edition 0.1 / Seite 4 von 28

5 Einleitung 1. Einleitung 1.1 Übersicht, Geltungsbereich Das Projekt Handbuch beschreibt, wie die Arbeit im Projekt organisiert ist. Es definiert die Werkzeuge und Methoden sowie die Umgebung in welcher das Projekt abgewickelt wird. Die verwendeten Werkzeuge werden in Form eines Betriebshandbuchs beschrieben. Der Hauptzweck dieses Dokuments besteht darin, die Projektarbeit zu erleichtern sowie die Produktivität und Qualität zu steigern. Aus diesem Grund sollen die im Dokument enthaltenen Vorgaben nicht primär als willkürliche Einschränkung der persönlichen Freiheiten verstanden werden. Die im vorliegenden Dokument definierten Regeln gelten für alle Projektmitglieder, Ausnahmen werden explizit erwähnt. 1.2 Abkürzungen 1.3 Referenzen Dok. BSP_0100 Edition 0.1 / Seite 5 von 28

6 Projektbeschreibung 2. Projektbeschreibung 2.1 Ausgangssituation Die Beispiel AG betreibt für ihre Kunden ein landesweites Netzwerk und Einrichtungen zur Verbreitung 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 zwischen allen 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 aktuellen 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 online Darstellung der pendenten Störungen. 2.2 Projektauftrag Aufgund der unbefriedigenden Situation im Störungsbehebungsprozess und unter dem Erwartungsdruck 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 s durch ein modernes Trouble Ticketing System abzulösen. Das neue System soll auch als Plattform für die Kommunikation mit den Kunden verwendet werden können 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). Kundenschnittstelle Sprache Web CIS SPOC Kunde (SLA) Work Flow Netzwerke Datenbanken NEMS NEMS Inventar DB Dispatching DB Figure 2.1: Systemgrenzen des Projekts CIS Dok. BSP_0100 Edition 0.1 / Seite 6 von 28

7 Projektbeschreibung 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) Rahmenbedingungen Das Trouble Ticketing System soll von allen Mitarbeitern (ca.300) der Beispiel AG genutzt werden können. Es wird erwartet, dass etwa 30 Kunden gleichzeitig am System angemeldet sein werden. 2.3 Projektziele 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. , 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örungsfälle verarbeitet werden können Sollziele Neben den Störungsfällen sollen auch geplante Unterbrücke oder periodische Wartungsarbeiten im Trouble Ticketing System erfasst werden können Kannziele Die Benutzer des Trouble Ticketing System sollen im zentralen User Directory (LDAP) verwaltet werden 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. Dok. BSP_0100 Edition 0.1 / Seite 7 von 28

8 Projektbeschreibung 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 Internet. 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 Datenbanken) Dokumentation Dokumentation für Kunden, Service Techniker und Administratoren. Die spezifische Benutzerdokumentation für Kunden und Service Techniker ist in Deutsch, die Administrationsdokumentation 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 eine klassische Vorgehensstrategie (Wasserfall) gewählt. Dok. BSP_0100 Edition 0.1 / Seite 8 von 28

9 Projektspezifisches Vorgehensmodell 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 Dok. BSP_0100 Edition 0.1 / Seite 9 von 28

10 Meilensteine und auszuliefernde Ergebnisse 4. Meilensteine und auszuliefernde Ergebnisse 4.1 Terminplan Kick-off mit Projektleitung der Beispiel AG Beginn der Spezifikationspase (erster Workshop mit Beispiel AG) Abgabe Spezifikation zur Review bei Beispiel AG Freigabe der Spezifikation für Implementation Start Schulung für Administratoren und Endbenutzer während Pilotbetrieb Start Inbetriebnahme Bereit für Pilotbetrieb Start Pilotbetrieb Abnahme Beginn Produktivbetrieb 4.2 Detailterminplan siehe Detailterminplan gemäss Dokument BSP_0110_DetailTerminplan.mpp Dok. BSP_0100 Edition 0.1 / Seite 10 von 28

11 Methoden und Werkzeuge 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 Dokumentation und Memos MS Word Office (Aktivität: z.b. Terminplanung; Werkzeug: z.b: MS Project, Version: z.b ) 5.3 Infrastructure 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 Unix Workstations All Unix workstations are interconnected with the server of the LAN. Dok. BSP_0100 Edition 0.1 / Seite 11 von 28

12 Organisatorischer Rahmen 6. Organisatorischer Rahmen 6.1 Projektorganisation (Kurzbeschreibung) Für die Abwicklung des Projekts wird ein Projektteam gebildet, das während der ganzen Projektdauer besteht. Die geplante Auslastung für Arbeiten in Zusammenhang mit diesem Projekt beträgt 80% der normalen Arbeitszeit der Projektmitarbeiter. 6.2 Organisationsdiagramm Auftraggeber Beispiel AG Kommerzieller Projektleiter Hans Frank Technischer Projektleiter Guido Work ARS Server Fritz Meier Web Infrastructure Stefan Net CIS Infrastructure Klaus Intern Workflow Thomas Hierlang Web GUIs Peter Window Interfaces Jo Dazwischen 6.3 Aufgaben und Verantwortlichkeiten Vertreter des Auftraggebers Aufgabe / Rolle Name Abt./Firma Telefon Projektleiter Marcel Boss Beispiel AG marce.boss@beisp.com Einkauf Albert Kauf Beispiel AG albert.kauf@beisp.com IT Verantwortlicher James Oracle Beispiel IT AG james.oracle@beisp.com Projektleitung Aufgabe / Rolle Name Abt./Firma Telefon Technischer Projektleiter Guido Work guido.work@wir.com 11 Kommerzieller Projektleiter Hans Frank hans.frank@wir.com 12 Dok. BSP_0100 Edition 0.1 / Seite 12 von 28

13 Organisatorischer Rahmen Aufgabe / Rolle Name Abt./Firma Telefon Verantw. Qualitätssicherung Guido Work guido.work@wir.com Projektteam Aufgabe / Rolle Name Abt./Firma Telefon ARS Server Fritz Meier fritz.meier@wir.com 22 Workflow Thomas Hierlang thomsa.hierlang@wir.com 23 Web Infrastructure Stefan Net stefan.net@wir.com 24 Web GUIs Peter Window peter.window@wir.com 26 CIS Infrastructure Klaus Intern klaus.intern@wir.com 28 Interfaces Jo Dazwischen jo.dazwischen@wir.com Informationskonzept Besprechungsstruktur Besprechnungszyklus Besprechungsart Teilnehmer wöchentlich monatlich Datum bei Bedarf IPM X Montags 0900 TPL, Projektteam EPM X 1. Woche des TPL, Auftraggeber Montats PL Meeting X TPL, KPL 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 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 Dok. BSP_0100 Edition 0.1 / Seite 13 von 28

14 Organisatorischer Rahmen 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 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 Workshop (WS) The workshop meetings are held to discuss technical problems, i.e. to work for a concept or a detailed 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. Dok. BSP_0100 Edition 0.1 / Seite 14 von 28

15 Organisatorischer Rahmen Kommunikation und Reporting Verwaltung von Kontaktinformationen Der technische Projektleiter verwaltet die Adressen und Kontaktinformationen der am Projekt beteiligten Personen Eingesetzte Kommunikationsmittel und Verschlüsselung Für die Kommunikation sind folgende Mittel vorgesehen: Fax Telefon Die Kommunikation erfolgt unverschlüsselt Berichtswesen und Reporting Inhalt/Form Verantwortlich Empfänger Intervall Statusbericht intern TPL GL monatlich Statusbericht extern TPL Auftraggeber, cc KPL monatlich Leistungserfassung Die Projektmitglieder erfassen die aufgelaufenen Aufwände und Auslagen mindestens wöchentlich im Leistungserfassungs-Tool. Dok. BSP_0100 Edition 0.1 / Seite 15 von 28

16 Standards und Richtlinien 7. Standards und Richtlinien 7.1 Verwendete Standards, Werkzeuge und Richtlinien Aktivität / Produkt Standards / Werkzeuge / Richtlinien 7.2 Verwendete Vorlagen Aktivität / Produkt Beschlussfassung Review Vorlagen Beschlussliste Reviewprotokoll 7.3 Documentation General Aspects The development documentation must be written in English, whereas training documents, protocols 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 Dok. BSP_0100 Edition 0.1 / Seite 16 von 28

17 Standards und Richtlinien 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 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 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 selected 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. Dok. BSP_0100 Edition 0.1 / Seite 17 von 28

18 Standards und Richtlinien 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 members. If you have any suggestions for their improvement, please contact the technical project manager 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 templates. \\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 FilePrintDefault) 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 moves 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 appropriate to use a table. Tables have the advantage, that inside any cell the text is formatted automatically (left and right borders). Dok. BSP_0100 Edition 0.1 / Seite 18 von 28

19 Standards und Richtlinien 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 Options (Tools command, Workgroup templates in the File Locations tab ) 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 (respectively 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 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 ): 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.] ) 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, probably 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 according fields. Dok. BSP_0100 Edition 0.1 / Seite 19 von 28

20 Standards und Richtlinien Template for documents Template name: Used for: BSP_DOC_english documents listed in the document status list [BSP_0105] Style name Styles in the template (listed alphabetically): Short cut key Style description 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, styles of the Left-, Center-, Right-Part of the footer of pages 2 n FooterR grafic ALT+G used for figures and tables; includes space before and keeps Yes next line (Caption) on the same page grafic big same as grafic but beginning on left border without indent Yes Header style for the header Header1, used in the document headers only Header2, Header3 Heading ALT+1 Heading for level 1 9, but only level 1 4 should be used. Yes 1 9 ALT+5 Heading text is inserted automatically into the Table of contents. Before Heading 1 a page break is inserted automatically. 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 Title 1 not numbered TOC 1 9 Table 7.1: 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 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. Styles for Table of contents. Styles in template BSP_DOC for general use (Yes) 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. Dok. BSP_0100 Edition 0.1 / Seite 20 von 28

21 Standards und Richtlinien 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 predefined locations. Out of that the following procedure is recommended if a new document is begun: 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 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: Used for: BSP_MEMO memos (e.g. minutes of meeting) Style name Short cut key Style description Caption style of captions for tables and figures; caption text is inserted automatically into the Table of figures Footer, style for the footer Footer1 Header, style for the header Header2 Heading ALT+1 Heading for level 1 9, but only level 1 4 should be used. Yes 1 9 ALT+5 Indent ALT+I Hanging indent of text by 1 cm Yes List 1 ALT+L List with bullets, level 1 (bold style); following style Yes List 2 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 for general use 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. Dok. BSP_0100 Edition 0.1 / Seite 21 von 28

22 Standards und Richtlinien 7.4 Aktenordnung und Ablage von Erzeugnissen 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 Dokumentenmanagement und Kennzeichnung Dokumentenstati Status planned edit review in revision released acceptance revised closed Comment Dieses Dokument ist geplant Dieses Dokument wird zur Zeit bearbeitet Dieses Dokument ist beim Auftraggeber zur Review Dieses Dokument ist intern zur Review Dieses Dokument wurde für internen Gebrauch oder Kunden freigegeben Dieses Dokument ist für die Acceptance relevant Dieses Dokument wurde überarbeitet Dieses Dokument wird nicht mehr nachgeführt Dok. BSP_0100 Edition 0.1 / Seite 22 von 28

23 Standards und Richtlinien Dokumentenbezeichnung Die Dokumente werden durch eine Projektabkürzung (z.b. BSP_), eine vierstellige Dokumentennummer und ein abgekürzter Dokumenttitel gekennzeichnet. Beispiel: BSP_8600_IGOverview Der technische Projektleiter vergibt die Dokumentennummern anhand des folgenden Schemas: Bereich Bedeutung Projekt Dokumente System Dokumente Database Applikationen Core Applikationen Web Applikationen Workflow Applikationen Interface Applikationen Schulungs Dokumentation User Dokumentation (Install, User, Admin Guides) reserved Unterbereich x000 - x099 x100 - x199 x200 - x299 x300 - x399 x400 - x499 x500 - x599 x600 - x699 x700 - x799 x800 - x899 x900 - x999 Bedeutung Subprojekt Dokumentation (Organisation, ) Konzepte (x100: Allgemeines Konzept) Spezifikationen (Requirements, Interface Specifications, ) Design und Implementation Dokumente Test Dokumente Acceptance Dokumente Installations Dokumente Konfigurations Dokumente Operation Dokumente 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 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 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. Dok. BSP_0100 Edition 0.1 / Seite 23 von 28