Uniwersytet Zielonogórski

Instytut Edukacji Techniczno Informatycznej

Pracownia techniczna I

Dokumentacja techniczna i jej elementy składowe. Formy pracy.

Dokumentacja to całość opisów wyjaśniających działanie programu lub pakietu oprogramowania. Konwencjonalnie rozróżnia się dokumentację techniczną i użytkową. Dokumentacja musi być stale uaktualniana, aby obejmowała wszelkie zmiany i poprawki dokonywane w programie podczas cyklu życia. Oprogramowanie bez dokumentacji jest niepełnowartościowe, a niekiedy – bezużyteczne. Napisanie dobrej dokumentacji wymaga znajomości przedmiotu oraz ogólnej kultury językowej.

Dokumentacja techniczna (angielskie technical documentation), szczegółowy opis programów, baz danych, interfejsów, danych i przebiegów sterowania, przeznaczony dla osób zaangażowanych w rozwój przedsięwzięcia informatycznego. Podstawowym składnikiem dokumentacji technicznej są teksty źródłowe programów, ze starannie dobranym nazewnictwem i aktualnymi komentarzami.

DOKUMENTACJA TECHNICZNA, zbiór dokumentów zawierających dane niezbędne do wyprodukowania określonego wyrobu lub wykonania określonych prac; np. dokumentacja techniczna maszyny obejmuje: dokumentację konstrukcyjną, określającą jednoznacznie wyrób, jego części składowe i warunki techn. jakie ma spełniać, oraz dokumentację technologiczną, omawiającą sposoby wykonania wyrobu właściwej jakości, przy optymalnym rozwiązaniu zagadnień dotyczących zużycia materiałów, pracochłonności, wydajności i kosztów własnych; dokumentacja techniczna budowli to m.in. projekty arch., konstrukcyjne (obliczenie statystyczne i wytrzymałościowe, rozwiązania konstrukcyjne poszczególnych elementów budowli itp.) i instalacyjne; szczegółowość opracowania dokumentacji technicznej zależy od skali produkcji i kwalifikacji wykonawców.

I.       Założenia projektowo-konstrukcyjne.

1. Opis potrzeby, sformułowanie zadania.

W punkcie tym opisujemy to co mamy wykonać, czyli nasz cel. Nie określany jednak go jednoznacznie pełna nazwą, wyznaczamy tylko cel dokładnie go opisując. Celowość jest nieodłącznym atrybutem każdej świadomej działalności, tzn. cokolwiek człowiek czyni, zawsze ma to jakiś cel. Cel działalności nie zawsze ma charakter użytkowo-materialny, może to być również naukowy, kulturalny, wypoczynkowy, np. studiowanie odpowiedniej lektury, pójście do teatru, wyjazd na wczasy itp. Cel ten może być bezpośredni lub pośredni, bliższy lub odleglejszy, ale zawsze istnieje. Źródłem celu działania i jego realizacji jest istnienie i odczuwanie przez człowieka określonej potrzeby. Chęć zaspokojenia danej potrzeby rodzi więc określony cel działania. Chodzi o to aby te potrzebę i wynikający z niej bezpośrednio cel zamierzonej pracy uświadomić sobie możliwie jak najdokładniej, aby cel pracy jak najgłębiej przeniknąć, gdyż to jest podstawą doboru właściwych środków i sposobów, prowadzących pewną i ekonomiczną drogę do osiągnięcia tego celu.

Cel powinien być: jeden, jasno i wyraźnie określony oraz realny.

Uświadomienie uczniom ce1owości podjęcia określonego zadania wytwórczego nie powinno polegać na tym, że nauczyciel podaje - zaplanowany przez siebie - temat tego zadania, a potem uzasadnia jego potrzebę; nie zawsze zapewnia to przekonanie uczniów o słuszności realizacji takiego zadania, a ty samym ma co najmniej wątpliwą wartość dla wywołania pozytywnego nastawienia i mobilizacji do aktywności w następnych fazach realizacji tego zadania. Korzystniejsze pod tym względem jest ukazanie uczniom konkretnej sytuacji praktycznej, z której w naturalny sposób wynika - w świadomości uczniów - potrzeba podjęcia określonego (ale jeszcze nie sformułowanego przez nauczyciela) zadania wytwórczego. Z zauważonej np. przez uczniów niejednokrotnie, a teraz uświadomionej im sytuacji, że na lekcjach techniki są często na poszczególnych stanowiskach roboczych używane drobne elementy łączeniowe (szczególnie gwoździe i wkręty różnej wielkości) i jest konieczne ułożenie ich w jednym miejscu dla zapewniania ładu na stanowisk pracy oraz zabezpieczenie przed mieszaniem się itd., wynika w naturalny sposób potrzeba wykonania "czegoś", co te warunki zapewni, więc odpowiednich skrzynek na te elementy. Na tej podstawie zostaje podjęta decyzja o celowości wykonania takich skrzynek.

Przykładem poprawnie określonego celu jest:

W każdym gospodarstwie domowym znajdują się potrzebne od czasu do czasu drobne narzędzia takie jak: młotek, obcęgi, kleszcze, wkrętak, pilnik itp. Często zdarza się tak, że w chwili, kiedy któreś z tych narzędzi jest potrzebne, nie można go znaleźć, bo zostało „gdzieś”  położone. Powtarzanie się takiej sytuacji sprawia, że człowiek czuje potrzebę utrzymywania wszystkich domowych narzędzi w jednym miejscu. Z tej potrzeby rodzi się cel oraz wynikające z niego zadanie do realizacji: wykonać „coś” dla przechowywania drobnych narzędzi.

2. Hipotetyczny opis środka (funkcje, wymagania)

W punkcie tym opisujemy jak nasz wytwór ma wyglądać i jakie ma spełniać funkcje, zajmujemy się wiec analizą jego funkcji oraz konstrukcji ale nie nazywamy go jeszcze jednoznacznie. W skrócie można powiedzieć, że wypisujemy tu to co przedmiot „powinien” spełniać.

Analiza zadania dotyczy więc dwóch spraw:

-          Planowanie konstrukcji danego przedmiotu (wynikiem jest tu projekt wytworu wyrażony odpowiednią dokumentacją graficzną);

-          Planowanie sposobu i przebiegu wykonania (jego rezultatem jest plan technologiczno-organizacyjny, w praktyce szkolnej zwany najczęściej tokiem pracy).

Analiza konstrukcji przedmiotu może mieć różny zasięg i charakter, zależnie od stopnia złożoności i „nowości” wytworu przewidzianego do wykonania, od posiadanych danych o tym wytworze itd.

W pełnej postaci występuje analiza konstrukcji wówczas, gdy zadanie wykonawcze nie jest szczegółowo znane i wymaga bliższego skonkretyzowania. Ma to miejsce przy wszystkich zadaniach o charakterze więcej czy mniej twórczym. Wówczas analiza musi dotyczyć w pierwszym rzędzie tych funkcji, jakie dany przedmiot ma spełnić, względnie tych potrzeb, które mają być zaspokojone w wyniku realizacji owego zadania. Jest to po prostu głębsze wniknięcie we wszystkie szczegóły uświadomionego celu pracy. Pominięcie tego momentu analizy pociąga za sobą niewłaściwe wykonanie zadania. Ana1iza zadania i p1anowanie pracy są bardzo ściśle ze sobą związane, przy czym planowanie opiera się na wynikach odpowiedniej analizy.

Planowanie konstrukcji musi poprzedzać ana1iza użytkowych funkcji (zadań) przyszłego wytworu, bowiem podstawą projektowania konstrukcji jest tzw. program funkcjonalno-użytkowy danego przedmiotu. Punkt wyjścia dla opracowania planu technologiczno-organizacyjnego stanowi ana1iza opracowanej już konstrukcji, z niej bowiem wynikają dane dotyczące liczby i wielkości elementów, sposobu połączenia ich itd. Te zależności i zdeterminowana nimi kolejność dwóch różnych co do charakteru części planowania i poprzedzających je dwóch odmiennych pod względem treści analiz, musi być zachowana również w zadaniach wytwórczych realizowanych przez uczniów. Dopiero po ścisłym ustaleniu funkcji można przystąpić do analizowania możliwości wykonawczych.

Przebieg tych dwóch faz cyklu organizacyjnego w pracy wytwórczej uczniów jest znacznie zróżnicowany. Zależy to z jednej strony od stopnia trudności zadań szczegółowych (projektowanie konstrukcji i opracowanie planu technologiczno-organizacyjnego) oraz możliwości udziału uczniów w ich realizacji, z drugiej zaś - od stosowanej w danym przypadku organizacyjnej formy wytwarzania. Praca nauczyciela w tym zakresie powinna być oparta na wskazaniach metodycznych, wynikających z zasad: aktywności uczniów oraz stopniowania trudności.

Przykład analizy dla wcześniejszego zadania może wyglądać następująco:

1.      Jakie szczegółowe funkcje ma owo „coś” spełniać? –

-          mieścić w sobie drobne narzędzia i przybory

-          jakie? – np. młotek, obcęgi, pilniki itd.

-          Narzędzia, gwoździe  itd. Nie mogą być wymieszane, powinny natomiast być oddzielone od siebie co najmniej pewnymi grupami ( np. narzędzia dłuższe i krótsze) aby łatwo można potrzebne z nich wynaleźć i wydobyć

-          Ponadto to „coś” powinno być wygodne w przenoszeniu gdyż zdarza się potrzeba robienia czy naprawiania czegoś w piwnicy lub ogródku

2.      Jaki przedmiot może te funkcje spełnić?

-          Jakaś skrzynka lub pudełko odpowiedniej wielkości. Niestety nie posiada ono odpowiednich przegród do rozdzielenia odpowiednich narzędzi

-          Powinna to więc być skrzynka specjalnie w tym celu wykonana: o odpowiedniej wielkości i głębokości z kilku przegrodami i uchwytem do przenoszenia.

3.      Z jakiego materiału powinna być ta skrzynka wykonana?

-          Nie może być z tektury, bo byłaby nietrwała

-          Może być z metalu, ale będzie zbyt ciężka, poza tym może tępić ostrza niektórych narzędzi

-          Najkorzystniejsze będzie wykonanie skrzynki z drewna.

4.      Jak  - ogólnie- powinna być ta skrzynka wykonana?

-          Musi być mocna, powinna też być estetycznie wykonana.

-          Nie musi być łączona na wczepy ani politurowana, bowiem jej funkcje nie wymagają tego

Niemniej ważną role odgrywa analiza procesu wykonania tego przedmiotu. Opiera się on w zasadzie na opracowanym poprzednio projekcie wytworu. Analiza procesu wykonania dotyczy środków i warunków realizacji danego projektu konstrukcyjnego, a więc szczegółowych sposobów wykonania składowych części przedmiotu i określonych operacji technologicznych, użycia odpowiednich materiałów i narzędzi, najbardziej ekonomicznej kolejności szczegółowych działań wykonawczych itp.

Analiza zadania jest nieodzownym przygotowaniem do planowania pracy.

3. Dane sytuacyjne.

W punkcie tym opisujemy warunki otoczenia jakie muszą być spełnione by stworzyć wytwór, zwracamy tu uwagę na narzędzia i urządzenia jakimi dysponujemy potrzebnymi do wykonania tego wytworu. Należy wziąć pod uwagę wielkość i oświetlenie przestrzeni operacyjnej oraz położenie stanowiska pracy w stosunku do innych stanowisk. Należy dobrać odpowiednie narzędzia do realizacji zadania, należy dobrać materiał oraz ewentualnie narzędzie pomocnicze. Przedmioty na stanowisku należy rozmieścić jak najkorzystniej aby nie musieć wykonywać zbędnych ruchów. Czystość i ład na stanowisku pracy ma być przez cały czas jej trwania.

Zwracamy tu także uwagę na to gdzie będzie przebywał wytwór po wykonaniu i jaką w związku z tym musi posiadać konstrukcje, funkcje oraz jak musi być wykonany.

4.      Dane ilościowe.

W punkcie tym opisujemy jaką ilość danego przedmiotu należy wykonać by spełnić założony wcześniej cel. Opisujemy dokładnie ilość poszczególnych elementów naszego wytworu.

II.    Kryteria optymalizacji.

W punkcie tym opisujemy jakie konkretne kryteria optymalizacji powinien posiadać nasz wykonywany przedmiot. Opis powinien być indywidualny i uzasadniony, konkretny a nie tylko uogólniony, opisujemy tu tylko swoje argumenty od strony wykonawcy. Zajmujemy się tu wszystkimi kryteriami tzn.: komplikacja konstrukcji, estetyka, ergonomia, funkcjonalność, uniwersalność, bezpieczeństwo, ekonomiczność, oryginalność, czas wykonania, trwałość, warunki do wykonania (realizacji celu), dostępność materiału, wymagane umiejętności do realizacji celu.

III.       Dobór cech konstrukcyjnych

W punkcie tym zamieszczamy wszystkie rysunki potrzebne do wykonania wyrobu.

IV.             Dobór cech technologicznych

W punkcie tym zamieszczamy kartę technologiczna, kartę materiałową, kartę kosztów i harmonogram pracy.

Najprostsza dokumentacja konstrukcyjna składa się z rysunku zło­żeniowego, przedstawiającego w połączeniu (złożeniu} poszczególne części danego wytworu, oraz z rysunków wykonawczych tych części. W szkole ogólnokształcącej, zwłaszcza na jej szczeblu podstawowym, stykają się uczniowie z dokumentacją tego rodzaju w odniesieniu do przedmiotów o nieskomplikowanej budowie. Szczególnie dotyczy to dokumentacji wykonywanej przez samych uczniów. Nie zmienia to jed­nak faktu, iż wchodzące w jej skład rysunki muszą być wykonane zgod­nie z ogólnymi zasadami obowiązującymi w rysunku technicznym.

Pomijając w tym miejscu świadomie merytoryczną stronę wykonywa­nia rysunków złożeniowych i wykonawczych obowiązujące zasady muszą być znane czytelnikowi z rysunku technicznego, należy zwrócić uwa­gę na to, że w dokumentacji konstrukcyjnej, wykonywanej przez ucz­niów, tabliczki rysunkowe powinny być dostosowane do potrzeb szkol­nych. Zasadnicza różnica między tabliczką rysunku wykonawczego a rysunku złożeniowego polega na tym, że tabliczka rysunku wykonawcze­go zawiera tylko podstawową część tabliczki (b), bez wykazu części (a). Jest to pokazane na rysunku 1.