IT Docs

Dokumentacja projektów SWPS

Narzędzia użytkownika

Narzędzia witryny


projekty:start

Projekty SWPS

Aby dodać katalog dla dokumentacji projektu należy w poniższej liście dodać nowy wiki-link w postaci [[.<nazwa/skrót projektu>:]], np.: [[.test:]].

Po dodaniu do poniższej listy projekt pojawi się automatycznie na liście w menu bocznym (sidebar), więc prosimy o ostrożną edycję.

Następnie należy zgłosić w systemie Mantis potrzebę dodania nowej grupy do tworzenia dokumentacji projektu oraz listę użytkowników (kont), którzy mają być przypisani do tej grupy.

Po zapisaniu należy kliknąć na nowy link i wejść w edycję strony. Pierwszy nagłówek strony staje się automatycznie domyślną nazwą strony.

Dokumentowanie projektów

Strona główna projektu powinna zawierać podział na:

  • kartę projektu,
  • analizę wymagań,
  • dokumentację techniczną,
  • dokumentację użytkownika.

Wzór dokumentacji

Aby uzyskać taki efekt należy w edytorze wpisać następującą składnię:

====== <nazwa projektu> ======
Dokumentacja projektu <nazwa projektu> składa się z następujących elementów:
  * [[.Karta projektu]]
  * [[.Analiza wymagań:]]
  * [[.Dokumentacja techniczna:]]
  * [[.Dokumentacja użytkownika:]]

Opis każdej z dokumentacji można umieścić na jednej stronie bądź podzielić je na sekcje i umieścić na osobnych stronach.

Całość będzie prezentować się w następującym drzewie:

-+- projekty
 |-+- <nazwa projektu>
   |--- Karta projektu
   |-+- Analiza wymagań
     |-+- <strona1>
     |-+- <strona2>
     |-+- <...>
     |-+- <stronaN>
   |-+- Dokumentacja techniczna
     |-+- <strona1>
     |-+- <strona2>
     |-+- <...>
     |-+- <stronaN>
   |-+- Dokumentacja użytkownika
     |-+- <strona1>
     |-+- <strona2>
     |-+- <...>
     |-+- <stronaN>

Karta projektu

Karta projektu powinna zawierać podstawowe informacje techniczne o projekcie. Przykładowo:

Karta projektu Projekty SWPS
Kod projektu ?
Nazwa projektu ?
Status projektu ?
Właściciel projektu (zarządzający) ?
Położenie źródeł ?
Dokumentacja utrzymaniowa 1)
Dokumentacja użytkownika 2)
Opis/Uwagi
3)
Producent ?
Menadżer
4) user@swps.edu.pl
+48 22 55 55 555
Czy jest wparcie 5)
SLA wsparcia 6)
Kontakt wsparcia
7) user@swps.edu.pl
+48 22 55 55 555

Powyższe dane są tylko przykładem. W zależności od projektu informacji może być więcej.

Lista projektów

1) , 2) link wewnętrzny lub załączyć dokument
3) krótki opis lub ew. uwagi
4) , 7) Imię Nazwisko
5) tak/nie/wewnętrzne
6) warunki SLA
projekty/start.txt · ostatnio zmienione: 2017-03-07 14:59 przez Maurycy Czerwieniec