F. függelék – Projektdokumentáció-sablon

Kitölthető váz a vizsga projektmunkájához — nyolc fejezet, kész táblázatok, és minden szakasznál az, hogy melyik értékelési szempontot szolgálja.

Ebben a fejezetben
  1. F.1 A formai követelmények
  2. F.2 Címlap és fejléc
  3. F.3 1. fejezet — A feladat és a technológia leírása (1–2 oldal)
  4. F.4 2. fejezet — Folyamatábra és I/O-lista (1–2 oldal)
  5. F.5 3. fejezet — Hardverkonfiguráció és bekötési rajzok (2–3 oldal, 20%)
  6. F.6 4. fejezet — Paraméterek (1–2 oldal, 10%)
  7. F.7 5. fejezet — A program ismertetése (2–3 oldal, 20%)
  8. F.8 6. fejezet — Beüzemelés és kezelőfelület (1–2 oldal, 10% + 10%)
  9. F.9 7. fejezet — Működésvizsgálat és naplókivonat (1–2 oldal, 10%)
  10. F.10 8. fejezet — Összegzés, önreflexió, mellékletek (1 oldal, 10%)
  11. F.11 Beadás előtti ellenőrzőlista
  12. F.12 A bemutató (5–8 dia)

Ez a függelék munkaeszköz: a vizsga projektmunkájának dokumentációjához ad kitölthető vázat. A szerkezet a 25.7. alfejezet szerinti — a hivatalos értékelési arányokhoz illesztve —, a táblázatok pedig úgy készültek, hogy másolhatók és kitölthetők legyenek.

⚠️ Ez váz, nem kész dolgozat

A sablon a szerkezetet és a kérdéseket adja. A tartalom a te munkád: a te géped, a te méréseid, a te döntéseid. Egy kitöltetlenül beadott sablon rosszabb, mint a saját szavakkal írt, egyszerűbb dokumentáció.

F.1 A formai követelmények

Követelmény Érték
Terjedelem minimum 10 – maximum 15 oldal
Fotódokumentáció a munkafolyamat fotóval is dokumentálva
Beküldés a vizsga előtt legalább 15 nappal, elektronikusan
Bemutatás 5–8 dia vagy rövid videó
A bemutató része önreflexió
💡 A terjedelem nem cél, hanem korlát

A 15 oldal felső határ. A bizottság nem a hosszt értékeli, hanem azt, hogy a nyolc szempont mindegyikéhez tartozik-e bizonyíték. Egy 11 oldalas, fotókkal és jegyzőkönyvvel teli dokumentáció többet ér, mint egy 15 oldalas, amelyben három oldal a program kinyomtatva.

Oldalkeret fejezetenként (a 25.7. alfejezet szerint):

# Fejezet Oldal Értékelési szempont
1 A feladat és a technológia leírása 1–2 folyamatértelmezés
2 Folyamatábra és I/O-lista 1–2 módszertan
3 Hardverkonfiguráció és bekötési rajzok 2–3 20%
4 Paraméterek 1–2 10%
5 A program ismertetése 2–3 20%
6 Beüzemelés és kezelőfelület 1–2 10% + 10%
7 Működésvizsgálat és naplókivonat 1–2 10%
8 Összegzés, önreflexió, mellékletek 1 10% (+ bemutatás 10%)

F.2 Címlap és fejléc

KÓD
............................................................
        <A projekt címe>

        Készítette:      <név>
        Képzés:          PLC programozó (07145003)
        Vizsgaidőszak:   <év, hónap>
        Beadás dátuma:   <dátum>
        Dokumentumverzió: <pl. 1.2>
        Projektarchívum:  <fájlnév>.projectarchive
............................................................

⚠ A dokumentumverzió és a projektarchívum fájlneve a címlapra való. Ez az a két adat, amelyből a bizottság látja, hogy a beadott leírás és a beadott program összetartozik.

F.3 1. fejezet — A feladat és a technológia leírása (1–2 oldal)

Amit tartalmaznia kell:

  1. Mit csinál a berendezés? — 8–12 mondat, időrendben: mi indítja, mi történik, mi állítja le, mi történik hibánál.
  2. Milyen üzemmódjai vannak? — automata, kézi, esetleg beállító üzem; mi a különbség.
  3. Mi a feladat határa? — mit nem csinál a rendszer (ezt is le kell írni).
  4. Kiegészítő feltevések — amit a leírás nem mondott meg, és te döntötted el.
💡 A negyedik pont a legtöbbet érő

Egyetlen technológiai leírás sem teljes. Ha leírod, mit tételeztél fel — „a leírás nem mondja meg, mi történjen bekapcsoláskor; a rendszer alaphelyzetbe áll, és nyugtázást vár” —, azzal nem hiányosságot vallasz be, hanem mérnöki gondolkodást mutatsz.

Kitöltendő táblázat — a feltevések:

# Amit a leírás nem mond meg Amit feltételeztem Miért ezt?
1
2
3

F.4 2. fejezet — Folyamatábra és I/O-lista (1–2 oldal)

Folyamatábra: az 5. fejezet jelöléseivel és az öt szerkesztési szabály betartásával. Ha a rendszernek két üzemmódja van, mindkettő szerepeljen — vagy egy ábrán, üzemmódválasztó elágazással, vagy két ábrán, jelölve, hol találkoznak.

I/O-lista — ez a dokumentáció legértékesebb egyetlen táblázata:

Csatorna Cím Változónév Jeltípus Eszköz típusa Funkció
X12.5 %IX0.2 bSzalagVegallas 24 V DC PNP induktív közelítéskapcsoló a szállítószalag végállása

⚠ A bontó (NC) jeleket külön jelöld a Funkció oszlopban: „vészgomb — NC, nyugalmi állapotban TRUE”. Enélkül a listát olvasó fordítva érti a logikát (13.7).

Ellenőrző kérdés a listához: add oda valakinek, aki nem ismeri a rendszert, és kérdezd meg, mi történik, ha a DI3 aktív lesz. Ha nem tudja megmondani, a lista hiányos.

F.5 3. fejezet — Hardverkonfiguráció és bekötési rajzok (2–3 oldal, 20%)

Eszközlista:

# Eszköz Típus / cikkszám Szerep Megjegyzés
1 vezérlő WAGO CC100 (751-9301) fő vezérlő
2

Tápellátás:

Adat Érték Forrás / indoklás
Tápfeszültség 24 V DC, SELV a vezérlő követelménye (7.2)
Tűrés −15 … +20 % (20,4 … 28,8 V)
Mért tápfeszültség multiméterrel mérve, dátum
Kimeneti oldal összes áramfelvétele a beavatkozók összege
Tápegység névleges árama tartalékkal

Bekötési rajz: csatlakozó- és lábszámokkal. A rajzon jelöld:

  • az érzékelők típusát (PNP / NPN), és hogy melyik eszközre köthetők;
  • a kimenetek jellegét (sourcing / sinking) — eltérő gyártóknál ez nem azonos (21.2);
  • az induktív terhelésekhez tartozó szabadonfutó diódát;
  • a biztonsági kör vezetékeit — külön színnel, mert az nem a PLC-n megy át.
⚠️ Amit ennél a fejezetnél a legtöbben elrontanak

A hardverfejezet 20% — a legnagyobb súlyú tétel a programmal együtt. Az önértékelő lap kérdése a mérce: „Fel tudná építeni valaki más a dokumentációm alapján?” Ha a rajzról hiányzik a lábszám vagy a vezetékszín, a válasz nem.

F.6 4. fejezet — Paraméterek (1–2 oldal, 10%)

Minden paraméternél három adat kell: az érték, a hol-állítható, és az indoklás.

Hálózati paraméterek:

Eszköz IP-cím Alhálózati maszk Átjáró Port Megjegyzés
CC100
bővítőmodul 502 Modbus TCP
programozó PC

Modbus-paraméterek:

Adat Érték Indoklás
unit ID a modul dokumentációja / mérés
funkciókód (olvasás) melyik táblát olvasod
PDU-offset mért érték, nem feltételezett (21.5)
válaszidő-túllépés miért ennyi
lekérdezési ciklus

Task-paraméterek:

Adat Érték Indoklás
task típusa miért ciklikus / szabadonfutó
intervallum mihez igazítottad
prioritás
watchdog Time
watchdog Sensitivity a kioldás = Time × Sensitivity (8.7)
mért átlagos ciklusidő task-monitorozásból (23.7)
mért maximális ciklusidő ez dönti el, kiold-e a watchdog

⚠ Az indoklás oszlop nélkül ez a fejezet a felét éri. „Intervallum: 20 ms” — kevés. „Intervallum: 20 ms, mert a legrövidebb figyelendő jel 50 ms, és így két beolvasás is jut rá” — ez a válasz.

F.7 5. fejezet — A program ismertetése (2–3 oldal, 20%)

POU-szerkezet:

POU Típus Feladata Hívja
PLC_PRG PROGRAM fő logika, üzemmódváltás MainTask
FUNCTION_BLOCK
FUNCTION

A fő logika magyarázata — ne a kódot ismételd meg szavakban, hanem a döntéseket indokold:

# Tervezési döntés Miért így? Mi lett volna az alternatíva?
1 pl. állapotgép CASE-szerkezettel a lépések sorrendje így követhető SFC — de a vizsgán a szöveges nyelv gyorsabban módosítható
2 pl. RS (reset-domináns) bistabil egyidejű start és stop esetén ne induljon SR — nem felelt volna meg
3

A biztonsági jelek kezelése — külön alfejezet, néhány mondat:

  • melyik jel NC (bontó), és a programban hogyan jelenik meg;
  • miért nem a PLC-program valósítja meg a vészleállítást (24.14);
  • mi történik kommunikációkiesés esetén.

Kódrészletek: csak a lényeges részek, kommentekkel. A teljes programlista a mellékletbe való, nem a törzsszövegbe.

F.8 6. fejezet — Beüzemelés és kezelőfelület (1–2 oldal, 10% + 10%)

Beüzemelési lépéssor — és ami ennél fontosabb: hol akadtál el.

# Lépés Eredmény Elakadás / megoldás
1 bekötés, feszültségmentesen
2 tápfeszültség mérése
3 hálózati elérés (ping)
4 eszközleírás telepítése
5 első letöltés, indító alkalmazás
6 I/O-leképezés ellenőrzése
7 bővítőmodul felderítése, címzés mérése
8 első teljes működési próba

Kezelőfelület — képernyőkép + a hét kötelező elem jelölése:

Elem Hol van a felületen?
üzemmódjelzés
kezelőgombok
paraméterbevitel (pl. cél darabszám)
állapotjelzés
adatok (darabszám, hőmérséklet…)
riasztások
programverzió

⚠ A programverzió a leggyakrabban kifelejtett elem — és hibakeresésnél az első kérdés.

F.9 7. fejezet — Működésvizsgálat és naplókivonat (1–2 oldal, 10%)

Próbaüzemi jegyzőkönyv — a 26.11. alfejezet mintája szerint. A jobb szélső két oszlop nélkül a jegyzőkönyv nem jegyzőkönyv:

# Mit vizsgálunk? Hogyan? Elvárt eredmény Tapasztalt Megfelelt?
1 indítás engedéllyel ajtó zárva, Indítás a szalag elindul
2 indítás engedély nélkül ajtó nyitva, Indítás nem indul
3 darabszámlálás 10 darab áthaladása a számláló 10
4 célérték elérése a cél elérése megáll, lámpa BE
5 nyugtázás Nyugtázás gomb számláló és lámpa törlődik
6 kézi üzemmód léptetés nyomva tartása megy, nem számol
7 üzemmódváltás futás közben automata → kézi megáll
8 ajtónyitás futás közben ajtó nyitása megáll
9 vészleállítás vész-gomb azonnal megáll, a HMI jelez
10 vész visszaállítása kioldás + nyugtázás nem indul magától
11 áramszünet táp ki-be a darabszám megmarad (RETAIN)
12 kommunikációkiesés a modul kábelének kihúzása biztonságos állapotba megy

Aláírás: Elvégezte: …………… Dátum: …………… Ellenőrizte: ……………

Naplókivonat: a 23. fejezetben tanult Log-export egy jellemző részlete — időbélyeggel, súlyossággal, komponenssel. Ez bizonyíték arra, hogy valóban végeztél működésvizsgálatot.

⚠️ A két legfontosabb sor

A 10. sor azt bizonyítja, hogy a visszaállítás nem indít, csak engedélyez. A 12. sor azt, hogy végiggondoltad, mi történik, ha a bővítőmodul nem válaszol — és hogy a válasz nem „a program megy tovább az utolsó ismert értékkel”.

F.10 8. fejezet — Összegzés, önreflexió, mellékletek (1 oldal, 10%)

Az önreflexió négy kérdése — ezekre saját szavakkal, konkrétan:

Kérdés Mit várnak?
Mi működött jól? konkrét megoldás, nem „minden jó lett”
Mi nem sikerült elsőre? valódi nehézség, a javítással együtt
Mit csinálnál másképp? tervezési, nem szerelési apróság
Mit tanultál, amit nem vártál? ez a legőszintébb és a legértékesebb pont
💡 Önreflexió — nem önfényezés

Az „a projekt sikeresen megvalósult, minden működik” mondat nem önreflexió, és pontot sem ér. Az „a Modbus-címzést két napig kerestem, mert a dokumentáció 1-től számoz, a protokoll 0-tól — legközelebb a mérést kezdem ezzel” viszont igen.

Mellékletek jegyzéke:

# Melléklet Fájlnév
1 projektarchívum <…>.projectarchive
2 teljes programlista
3 bekötési rajz nagy méretben
4 fotódokumentáció
5 naplókivonat (XML)
6 mért regisztertáblázat

F.11 Beadás előtti ellenőrzőlista

Ez a lista a 26.14. alfejezet önértékelő lapját és a leggyakoribb hiányosságokat fogja össze.

# Ellenőrzés ✔
1 10–15 oldal, a fejezetek a hivatalos arányok szerint
2 Fel tudná építeni valaki más a hardvert a dokumentációm alapján?
3 Minden paraméternél ott van, miért az az érték?
4 Indokoltam a tervezési döntéseket, nem csak leírtam a kódot?
5 A beüzemelésnél jelöltem, hol akadtam el?
6 A kezelőfelület használható magyarázat nélkül?
7 Van kitöltött próbaüzemi jegyzőkönyv, benne a vészkör próbája?
8 Van naplókivonat a működésvizsgálathoz?
9 Van fotó munka közben, nem csak a végén?
10 A projektarchívum (nem csak a .project fájl) a mellékletben van?
11 Az önreflexió valódi nehézséget nevez meg?
12 A vészkör huzalozott, nem a PLC-programon megy át?
13 Az I/O-listán jelölve vannak a bontó (NC) jelek?
14 A címlapon ott a dokumentumverzió és az archívum fájlneve?
15 Beadás a vizsga előtt legalább 15 nappal?
⚠️ Az öt leggyakoribb hiányosság
  1. Nincs vészkör — vagy van, de a PLC-n keresztül megy.
  2. Nincs próbaüzemi jegyzőkönyv — a „működik” nem bizonyíték.
  3. Nincs indoklás a paramétereknél, csak értékek.
  4. Nincs archívum, csak a projektfájl.
  5. Nincs önreflexió — helyette önfényezés.

Mind az öt könnyen javítható, és mind az öt pontot ér.

F.12 A bemutató (5–8 dia)

Dia Tartalom
1 Cím, név, a feladat egy mondatban
2 A technológia és az üzemmódok
3 Hardver: fotó és a bekötés lényege
4 A program szerkezete — egy ábra, nem kódlista
5 Kezelőfelület — képernyőkép
6 Működésvizsgálat — a jegyzőkönyv egy részlete
7 Önreflexió — mi nem sikerült elsőre, és mit tanultál belőle
8 (tartalék) továbbfejlesztési lehetőségek
💡 A 7. dia a bemutató lelke

A bizottság sok „minden működik” bemutatót lát. Amelyik megmarad, az az, amelyik egy valódi hibát mutat be, és azt, hogyan találtad meg. Ez a dia bizonyítja, hogy nem betanultad a projektet, hanem megcsináltad.

Mennyire volt hasznos ez a fejezet?

Még nincs értékelés.