Dokumentacja techniczna Dell Extcdr 1 opisuje funkcjonalność systemu zarządzania danymi Dell Extcdr 1. Jest to oprogramowanie do tworzenia, przechowywania, wyszukiwania i udostępniania danych. System ma szerokie możliwości, przy czym główne funkcje obejmują tworzenie i przechowywanie danych w formacie XML, wyświetlanie kodu XML w przyjaznym dla użytkownika interfejsie, a także zarządzanie i wyszukiwanie danych za pomocą złożonych zapytań. System Extcdr 1 jest także wyposażony w narzędzia do tworzenia i wdrażania procedur użytkownika, a także w zintegrowane narzędzia do zarządzania bezpieczeństwem. System jest wyposażony w funkcje do tworzenia i udostępniania dokumentacji technicznej oraz szczegółowej informacji, dzięki czemu użytkownicy mogą wykonywać prace wydajnie.
Ostatnia aktualizacja: Dokumentacja techniczna Dell Extcdr 1
Z Encyklopedia Zarządzania
| Dokumentacja techniczna | |
|---|---|
| Polecane artykuły |
|
Dokumentacja techniczna to dokument opisujący techniczne działanie i parametry techniczne, które stanowią podstawę do wdrożenia produktu końcowego (wyrobu, budowli, instalacji itp. ). Zawiera wszystkie potrzebne dane umożliwiające wykonanie danego wyrobu. Mając do dyspozycji dokumentację techniczną można nie tylko podać przybliżony czas realizacji poszczególnych części składowych planowanego projektu ale także przedstawić wycenę kosztu całości realizacji (kosztorys), dzięki czemu można uniknąć dalszych nietrafionych inwestycji, w razie gdyby klient po uprzedniej analizie uznał, iż nie stać go na wdrożenie danego systemu, produkcję wyrobu, montaż instalacji itp. "W przypadku sklepów internetowych tworzenie tego dokumentu powinna poprzedzać specyfikacja funkcjonalna, która warunkuje dobór technologii wykonania"[1].
"Dokumentacja techniczna jest bardzo istotnym elementem projektu informatycznego. Bez niej wiele poważnych przedsięwzięć zakończyło się porażką. Bardzo skomplikowane i rozbudowane (a przez to kosztowne) projekty zazwyczaj posiadają cały pakiet dokumentacji. Nazywane pogardliwie stertami niepotrzebnych papierów sprawiają, że ostatecznie wszystko (przy zachowaniu należytej staranności) działa poprawnie. [2]"
Zawartość dokumentacji technicznej
Dokumentacja techniczna powinna[3]:
- "zawierać opis rozwiązania konstrukcyjnego,
- charakterystykę materiałową,
- informację dotyczącą projektowanych właściwości użytkowych wyrobu,
- określać warunki zastosowania wyrobu,
w miarę potrzeby
- zawierać instrukcję obsługi,
- instrukcję eksploatacji. "
A. Górecki podaje natomiast, że w niektórych przypadkach zawartość dokumentacji może zostać ograniczona tylko do niektórych dokumentów jak np. "receptura, opis przebiegu procesu technologicznego, warunki techniczne produkcji, skład wsadu[4]. "
Inne dokumentacje powiązane z dokumentacją techniczną
Dokumentacja wdrożeniowa
Dokumentację tą sporządza się osobom, które odpowiadają za wdrożenie produktu końcowego. Porównując ją do dokumentacji technicznej można zauważyć, że zawiera ona mniej informacji dotyczących "wewnętrznych zależności i komponentów ale zawiera wszystkie szczegóły wymagań, które musi spełnić środowisko pracy produktu- liczba serwerów baz danych, aplikacji, maksymalne (zalecane) wartości parametrów konfiguracyjnych itp. " W przypadku kiedy wdrożenie jest dokonywane przez osoby, które nie należą do zespołu projektowego (niezależnie czy jest to zespół wdrożeniowy naszej firmy czy nie) sporządzenie tej dokumentacji jest obligatoryjne[5].
Dokumentacja użytkownika
Przygotowywana dla użytkowników końcowych. Dokument ten jest często niezastąpiony jeżeli rozwiązanie jest "mało intuicyjne", czy też jeżeli schemat przebiegu pracy jest skomplikowany np. "przejdź tu, kliknij tu, pójdź tam zaznacz tamto, aby zatwierdzić, przejdź w kolejne miejsce- choć wydaje się to absurdalne, takie systemy istnieją"[6].
Dokumentacja projektu
Dokumentacja techniczna projektu powstaje w oparciu o dokumentację funkcjonalną ("w której przypadku użycia, procesy biznesowe, przepływ pracy podano w formie tekstu, obrazów oraz diagramów UML"). Jeżeli opis funkcjonalności jest napisany odpowiednio możliwe jest powstanie takiego wyrobu, który będzie odpowiadał wszystkim założeniom projektu. "Istnieje wiele technik zbierania wymagań funkcjonalnych (np. use cases- przypadki użycia, user stories- historie użytkowników. Obie metody opisu wymagań zostały opisane w odpowiedzi na pytanie: "Jak skutecznie zebrać wymagania? "). " Projekt przedstawiony w formie dokumentacji ułatwia jego szybkie wdrożenie. "Jeżeli projekt składa się z kilku mniejszych modułów (np. aplikacji głównej i aplikacji pośredniczącej w komunikacji), to takie informacje również powinny zostać zawarte w dokumentacji[7]".
Bibliografia
- Górecki A. (2006), "Technologia ogólna: podstawy technologii mechanicznych", Wydawnictwo WSiP, Warszawa
- Karwatka P. (2013), "Technologia w ecommerce. Teoria i praktyka. Poradnik menedżera", Wydawnictwo Helion, Gliwice
- Liderman K. (2003), Metodyka przeprowadzania audytu z zakresu bezpieczeństwa teleinformatycznego, Biuletyn Instytutu Automatyki i Robotyki, nr 19
- Lubina E. (2005), Metoda projektu w procesie dydaktycznym uczelni wyższej, Regionalny Ośrodek Metodyczno-Edukacyjny "Metis", Katowice
- Mincer- Daszkiewicz J. (2002), Tworzenie i wdrażanie produkcyjnego oprogramowania w środowisku akademickim, IV Krajowa Konferencja Inżynierii Oprogramowania, Poznań
- Wróblewski D. (2016), "BITP 2/2016: Bezpieczeństwo i Technika Pożarnicza / Safety & Fire Technique", Wydawnictwo CNBOP-PIB, Józefów
Przypisy
- ↑ P. Karwatka i in., 2013, s. 94
- ↑ P. 94
- ↑ D. Wróblewski, 2016, s. 163
- ↑ A. Górecki, 2006, s. 10
- ↑ P. 95
- ↑ P. 96
- ↑ P. 96
Autor: Aleksandra Brózda
Drogi Użytkowniku,
klikając przycisk „AKCEPTUJĘ” zgadzasz się, aby serwis Ceneo. pl sp z. o. i jego Zaufani Partnerzy przetwarzali Twoje dane osobowe zapisywane w plikach cookies lub za pomocą podobnej technologii w celach marketingowych (w tym poprzez profilowanie i analizowanie) podmiotów innych niż Ceneo. pl, obejmujących w szczególności wyświetlanie spersonalizowanych reklam w serwisie Ceneo. pl.
Wyrażenie zgody jest dobrowolne. Wycofanie zgody nie zabrania serwisowi Ceneo. pl przetwarzania dotychczas zebranych danych.
Wyrażając zgodę, otrzymasz reklamy produktów, które są dopasowane do Twoich potrzeb. Sprawdź Zaufanych Partnerów Ceneo. pl. Pamiętaj, że oni również mogą korzystać ze swoich zaufanych podwykonawców.Informujemy także, że korzystając z serwisu Ceneo. pl, wyrażasz zgodę na przechowywanie w Twoim urządzeniu plików cookies lub stosowanie innych podobnych technologii oraz na wykorzystywanie ich do dopasowywania treści marketingowych i reklam, o ile pozwala na to konfiguracja Twojej przeglądarki. Jeżeli nie zmienisz ustawień Twojej przeglądarki, cookies będą zapisywane w pamięci Twojego urządzenia. Więcej w Polityce Plików Cookies.Więcej o przetwarzaniu danych osobowych przez Ceneo. pl, w tym o przysługujących Ci uprawnieniach, znajdziesz tutaj.Więcej o plikach cookies, w tym o sposobie wycofania zgody, znajdziesz tutaj.Pamiętaj, że klikając przycisk „Nie zgadzam się” nie zmniejszasz liczby wyświetlanych reklam, oznacza to tylko, że ich zawartość nie będzie dostosowana do Twoich zainteresowań.
Nie zgadzam się
Dokumentacja techniczna jest to zespół dokumentów zawierający niezbędne dane techniczne, które umożliwiają wykonanie określonego przedmiotu (wyrobu, budowli, instalacji itp. ). Zakres dokumentacji i jej skład jest uzależniony od przeznaczenia.
Dokumentacja techniczna budowlana obejmuje opis techniczny danej budowli, obliczenia statyczne i wytrzymałościowe, rozwiązania konstrukcyjne poszczególnych elementów itp. Zawarte są w niej również rysunki orientacyjne i sytuacyjne. Dokumentacja techniczna urządzeń sanitarnych jest podobna do dokumentacji budowlanej.
Ogólnie w budownictwie występują dwa rodzaje dokumentacji:
– prawna,
– techniczna.
Dokumentacja prawna
Do dokumentacji prawnej zaliczamy lokalizację ogólną i lokalizację szczegółową. Lokalizacja ogólna to stwierdzenie potrzeby danej inwestycji na danym terenie, natomiast lokalizacja szczegółowa określa dokładnie, w którym miejscu ma stanąć dany obiekt budowlany, inaczej jest to akt stwierdzający prawa do terenu, na którym ma stanąć obiekt. Do
dokumentacji prawnej zaliczamy również wszystkie uzgodnienia z dostawcami, np. : wody, energii elektrycznej, energii cieplnej, gazu.
Dokumentacja techniczna
Dokumentacja techniczna jest to zespół obliczeń i projektów, na podstawie którego wykonuje się dany budynek, instalację, maszynę, itp. Do dokumentacji technicznej załącza się kosztorys. Dokumentację techniczną budowlaną wykonuje się w dwóch etapach:
– etap pierwszy – założenia techniczno-ekonomiczne,
– etap drugi – projekt techniczny.
Założenia techniczno-ekonomiczne podają ogólną koncepcję rozwiązania bez ustalania szczegółów. W projekcie technicznym rysuje się otwory okienne, drzwiowe, podaje się również wszystkie wymiary. Do projektu technicznego dołącza się obliczenia, z których wynikają wymiary poszczególnych konstrukcji przyjętych w projekcie.
W skład dokumentacji technicznej wchodzą:
– karta tytułowa,
– opis techniczny,
– obliczenia,
– plan orientacyjny,
– plan sytuacyjny,
– rysunki,
– kosztorys,
– zestawienie materiałów.
Karta tytułowa zawiera dane o dokumentacji technicznej, tzn. czego dotyczy, kto
wykonał, nazwę biura projektów lub nazwisko projektanta oraz nazwisko osoby
zatwierdzającej dokumentację.
Opis techniczny podaje w formie opisowej dane dotyczące projektu. Na przykład przy
projekcie instalacji ogrzewania centralnego podaje się, jaki jest rodzaj instalacji, jaki jest
rozdział – górny czy dolny, na podstawie czego zaprojektowano instalację, jaki przyjęto
czynnik grzejny, rodzaj kotła i inne.
Obliczenia stanowią bardzo ważną część dokumentacji technicznej. Błędne obliczenia
bardzo łatwo mogą spowodować katastrofę budowlaną, błędnie obliczony projekt instalacji
ogrzewania centralnego może być przyczyną np. niedogrzewania pomieszczeń. Obliczenia
wykonuje się na podstawie wzorów zawartych w odpowiednich normach.
Plan orientacyjny określa położenie działki, na której ma być budowany projektowany
obiekt. Teren lokalizacji oznacza się na podkładzie mapy lub planu zagospodarowania terenu
czy osiedla w podziałce nie mniejszej niż 1:25000. Orientację północną zaznacza się strzałką,
określającą kierunek północny (rys. 1).
Rys. 1 Rysunek planu orientacyjnego
Plan sytuacyjny określa dokładniej w porównaniu z rysunkiem orientacyjnym położenie (lokalizację) obiektu; na tych rysunkach podaje się kierunek przebiegu sieci i jej rodzaj;uwzględnia się również sieć istniejącą i projektowaną (rys. 2). pl/upload/image/doku2. 2 Plan sytuacyjny skala 1:500
Rysunki są potrzebne do wykonania danego elementu budynku, instalacji, itp.
W zależności od przeznaczenia projektowanego przedmiotu liczba rysunków oraz ich rodzaj będą różne. W dokumentacji technicznej instalacji przemysłowych i sanitarnych znajdują się rysunki obrazujące rzuty kondygnacji, rozwinięcia instalacji oraz rysunki szczegółowe.
Instalacyjne rysunki szczegółowe obejmują części urządzeń lub urządzenia bardziej skomplikowane, których wykonanie na zasadach rysunków przedstawiających rzuty czy rozwinięcia byłoby niemożliwe; wykonuje się je z zachowaniem odpowiedniej podziałki.
Kosztorys zawiera: zestawienie robót przewidzianych do wykonania, ilości poszczególnych robót, ceny jednostkowe oraz całkowity koszt obiektu.
W zestawieniu materiałów wyszczególnia się wszystkie potrzebne do wykonania robót materiały objęte kosztorysem i projektem. Zestawienie obejmuje materiały zasadnicze i pomocnicze. Ilość materiałów zasadniczych podaje się na podstawie projektu technicznego, natomiast ilość materiałów pomocniczych – na podstawie tabel, normatywów lub orientacyjnie.
