Základy inženýrského notebooku VRC

Inženýrský zápisník poskytuje studentům místo, kde si mohou procvičovat dovednosti psaní, vyjadřovat nápady prostřednictvím kreslení a vytvářet chronologický přehled o tom, jak tým využívá Engineering Design Process.

V profesionálním světě je technický notebook velmi důležitý. Inženýři používají tyto poznámky jako právní dokumentaci duševního vlastnictví a ke sdělování nápadů a pokroku ostatním členům svého týmu.

Tyto notebooky slouží podobnému účelu v konkurenční robotice. Nadace REC Foundation klade velký důraz na dobře navržené a provedené technické notebooky. Jednou z cest k úspěchu v soutěži je cena za design, která se primárně zabývá tím, jak tým používá proces návrhu a jak dobře dokumentuje tento proces v technickém notebooku.

V konečném důsledku by měl být notebook inženýrského designu považován za nástroj a ne za cíl sám o sobě. Tato příručka je úvodem do efektivního používání technického notebooku. Při správném použití posílí technický notebook kritické myšlení, spolupráci, kreativitu a komunikaci týmu.

Začínáme

Inženýrský zápisník je především chronologickým přehledem návrhových rozhodnutí. Ať už je notebook tištěný nebo elektronický, vždy by měl být historickým popisem toho, čím tým na své designérské cestě prošel. Měla by dokumentovat neúspěchy týmu i jeho úspěchy. Pokročilé týmové notebooky budou obsahovat dostatek podrobností, aby čtenář mohl znovu vytvořit týmového robota nebo kód podle kroků v notebooku.

Co byste měli používat jako notebook?

Sešity mohou být vytvořeny jako tištěné knihy nebo elektronické verze. Tištěné sešity mohou být stejně jednoduché jako anglická skladba a stejně tak efektní jako profesionální sešit v pevné vazbě. VEX Robotics nabízí dobrý notebook pro týmy VRC zde a pro týmy IQ zde. Bez ohledu na to, kterou knihu se rozhodnete použít, mějte na paměti, že všechny notebooky by měly splňovat následující minimální požadavky:

  • Všechny sešity by měly obsahovat obsah
  • Všechny stránky by měly být očíslovány
  • Všechny zápisníky by měly obsahovat chronologický popis práce týmu během jedné sezóny

Pokud vám dojde místo v tištěném sešitu, lze použít jinou knihu. Jednoduše očíslujte první knihu „1 z __“ a vyplňte celkový počet knih na konci sezóny.

Kdo by měl psát do sešitu?

Týmový zápisník slouží jako nástroj pro celý tým: designéry, konstruktéry, kodéry, řidiče a všechny ostatní, kteří pomáhají s robotem nebo jeho kódem. Do sešitu může psát kterýkoli nebo všichni členové týmu a každý člen týmu by do něj měl nějakým způsobem přispívat. Mnoho týmů určí jednoho člena týmu, který bude odpovědný za notebook. Tento „Notebook Manager“ může zajistit, že kniha bude uchována v bezpečí a že všechny záznamy budou v souladu se stylem týmu a celkovými cíli. Bez ohledu na to, kdo do sešitu píše a kdo ne, všichni členové týmu by měli být obeznámeni s obsahem. 

Kdo by NEMĚL psát do sešitu?

Poradcům, trenérům, rodičům a jakékoli jiné osobě, která není členem týmu, by NIKDY nemělo být dovoleno přidávat věci do technického zápisníku týmu. Pokud váš tým používá 2. podpisy jako svědky záznamů v poznámkovém bloku, může to udělat nečlen týmu, pokud nejsou k dispozici žádní členové týmu. Vše ostatní v poznámkovém bloku by měli vytvořit a zadat členové studentského týmu.

Co by mělo být v notebooku?

Je mnoho věcí, které vložit do sešitu, ale ne všechno by mělo v sešitu. Měly by být zahrnuty hlavní konstrukční úvahy, obrázky nebo výkresy prototypů a data shromážděná z testování. Záznamy mohou být ve formě výkresů, tiskových výstupů nebo textu. Všechny kroky Engineering Design Process by měly být podrobně popsány v týmovém technickém zápisníku.

Tým by měl zdokumentovat své postupy projektového řízení včetně využití personálních, finančních a časových zdrojů. Notebook by měl také obsahovat poznámky k počítačovému kódu robota, jak je navržen pro interakci s mechanickými systémy robota za účelem vytvoření celkového integrovaného systému. Umístění senzorů pro softwarové zpětnovazební systémy a algoritmy používané pro řízení robota by mělo být jasně zdokumentováno. Dobrý notebook by umožnil osobě, která nezná práci týmu, převzít návrh/konstrukci robota na základě podrobné dokumentace týmu.

Věci, které z notebooku vynechat

Ve studentském technickém zápisníku není množství vždy kvalitou. Zápisník by například neměl obsahovat celou příručku hry nebo jakýkoli jiný dokument, který nevytvořil tým. Pokud obsah nedemonstruje, že tým používá proces Engineering Design Process k návrhu, konstrukci, testování nebo kódování robota, pravděpodobně do notebooku nepatří.

Notebook není deník

Denní záznamy do deníku, které podrobně popisují rutinní týmové podnikání nebo nerobotické projekty, jako jsou online výzvy, nemusí být v zápisníku inženýrského designu. Mnoho týmů vytváří samostatný „týmový deník“ nebo zápisník pro tyto typy záznamů.

Týmový deník (neboli album/výstřižek) je příležitostí zdokumentovat vše, co tým dělá, aby mohl sloužit jako historický průvodce získanými zkušenostmi a osvědčenými postupy. Nejedná se o designový zápisník, ale spíše o místo, kde mohou týmy vyprávět svůj týmový příběh (historická časová osa týmu, poznámky ze setkání týmu, obrázky, životopisy studentů, poznámky ze soutěží, postřehy a myšlenky členů týmu, postupy organizace týmu a další další informace, které tým považuje za užitečné). Učitelé se mohou rozhodnout použít deník jako společné cvičení, ale deníky jsou zcela volitelné a porotci je nebudou shromažďovat. Je to způsob, jak mohou týmy říci, jak jim zkušenost VEX Robotics Competition pomohla vyvinout se jako lepší studenti.

Další informace o rozdílech mezi Engineering Notebookem a Team Journal naleznete v tomto článku.

Organizace notebooků

Neexistuje žádný všeobecně přijímaný „správný“ způsob, jak uspořádat technický zápisník, ale zde je několik tipů, jak začít:

  • Název týmu a číslo týmu by měly být viditelně zaznamenány na přední straně obálky každého svazku papírového sešitu; u elektronických poznámkových bloků by měl název souboru obsahovat tyto informace.
  • Je-li použito více tištěných sešitů, každý svazek by měl mít na nebo v přední části knihy „## z __“ (např. pokud jsou použity tři knihy, měly by být označeny „1 ze 3“; „2 ze 3“ “; a „3 ze 3“ na konci sezóny).
  • Titulní stránka na začátku sešitu by měla obsahovat podrobnosti jako:
    • Název týmu, číslo a škola/organizace
    • Seznam členů týmu a data, kdy se k týmu připojili; obsahovat datum ukončení, kdy člen odejde v polovině sezóny
    • Datum zahájení a datum ukončení daného konkrétního notebooku
  • Obsah by měl obsahovat:
    • Čísla stránek
    • Vstupní tituly
    • Termíny nástupů
  • Každá stránka by měla obsahovat následující:
    • Číslo stránky
    • Název, který popisuje práci dokončenou během pracovní relace
    • Datum vstupu
    • Seznam členů týmu, kteří ten den pracovali
    • Podrobné popisy práce provedené ten den, které mohou zahrnovat text, náčrtky, fotografie, textové plány/výsledky, brainstormingové seznamy a nápady do budoucna
  • Velké dílo může navíc těžit z abecedního rejstříku klíčových pojmů a informací nalezených v tomto konkrétním svazku. Tyto informace budou přidány na několik zadních stránek knihy po jejím dokončení. 

Kritéria úspěchu

Proces inženýrského návrhu

Každý Engineering Notebook je vytvořen společným úsilím týmu dokumentovat svá návrhová rozhodnutí. Týmy by měly začít své notebooky brzy a často je aktualizovat.

Inženýrství je iterativní proces, při kterém studenti rozpoznávají a definují problém, diskutují a pracují v různých fázích procesu návrhu, testují své návrhy, pokračují ve zlepšování svých návrhů a pokračují v procesu, dokud není identifikováno řešení. Během tohoto procesu studenti narazí na překážky, setkají se s případy úspěchu a neúspěchu a naučí se mnoho lekcí. Právě tento iterativní proces by studenti měli dokumentovat ve svém technickém notebooku.

Proces Engineering Design Process určuje základní strukturu a obsah technického notebooku. Podrobný popis typických kroků používaných týmy naleznete v článku o Procesu návrhu inženýrství.

Rubrika hodnocení nadace REC

Všichni členové týmu by se měli seznámit s Engineering Notebook Rubric. Rubrika zápisníku REC Foundation je bodovací příručka, kterou používají porotci turnajů k hodnocení kvality práce studentů. Uvádí všechna kritéria, která rozhodčí berou v úvahu při bodování týmových zápisníků. Týmy, které chtějí splnit nejvyšší standardy, se budou muset zaměřit na sloupec Expert v rubrice. Porotci vyhodnotí, jak dobře se týmový zápisník zabývá každým z těchto témat:

  • Proces inženýrského návrhu
    • Identifikujte výzvy a cíle při navrhování her a robotů
    • Brainstorm a řešení diagramů nebo prototypů
    • Vyberte nejlepší řešení a plánujte
    • Sestavte a naprogramujte řešení
    • Testovací roztok
    • Opakujte proces návrhu
  • Užitečnost a opakovatelnost týmové dokumentace
  • Užitečnost notebooku jako nástroje pro záznam týmových a projektových úkolů
  • Notebook obsahuje důkazy, že byl vytvořen postupně prostřednictvím procesu návrhu

Při studiu Engineering Notebook Rubric, zvažte, co jednotlivé body rubriky znamenají a co by porotce mohl hledat, aby rychle získal zápisník v tomto bodě rubriky.

Kód v noteboocích

Ne každý řádek kódu z každé revize týmového programu by měl skončit v týmovém zápisníku, ale je důležité, aby rozhodčí viděli, že týmový kód byl vyvinut paralelně s robotem. Týmy by si měly pamatovat, že porotci sledují proces návrhu robota týmu, včetně jejich kódu. Práce porotců při kontrole práce týmů je obtížná, když v procesu návrhu není mnoho odkazů na stavitele pracujícího s kodéry. Soudci mohou předpokládat, že namísto vývoje kódu paralelně s fyzickým robotem byl kód robota vymyšlen na poslední chvíli. Týmy, které zahrnou dokumentaci vývoje kódu jako součást svého notebooku, udělají pro rozhodčí lepší obrázek, aby mohli zhodnotit proces návrhu.

Je na každém týmu, aby určil, kolik kódu začlení do svého technického zápisníku. To se bude lišit tým od týmu a robot od robota. Týmy by měly obsahovat dostatek kódu, aby sdělily svůj proces návrhu porotcům. Týmy by měly zaznamenávat diskuse o vývoji kódu a zahrnovat příklady, které mohou být stejně jednoduché jako pseudokód, a také výsledky testů. Například záznam v poznámkovém bloku může obsahovat definici toho, které senzory/motory jsou přiřazeny ke kterému portu, a může obsahovat úryvky výjimečně inovativních částí kódu týmu.

Příkladem kódu, který je třeba z poznámkového bloku vynechat, je několik verzí podobného kódu, které jsou vytvořeny v procesu ladění. V tomto případě by tým měl jednoduše zaznamenat problémy, které se vyskytly během generování kódu a testování, a co bylo uděláno pro jejich překonání.

Není potřeba zahrnout každou revizi kódu do technického zápisníku. Týmy si mohou přát uchovávat všechny verze svého kódu v týmovém deníku, aby mohly sledovat veškerý vývoj svého kódu.

Tipy na dobré notebooky

  • Uložte svůj tištěný notebook na bezpečném místě.
  • Ujistěte se, že máte zálohy svého elektronického notebooku, pokud není uložen v cloudu.
  • Nikdy nedovolte, aby do vašeho poznámkového bloku něco přidal někdo, kdo není členem týmu. 
  • Začněte tištěné položky v horní části každé stránky a postupujte dolů. 
  • Všechny záznamy v papírových sešitech by měly být čitelné.
  • Označte vše, co do sešitu přidáte, zejména náčrtky a fotografie.
  • K označení obrázků a výkresů použijte systém číslování, aby na ně bylo možné snadno odkazovat.
  • Pokuste se vyplnit prázdná místa obrázky, návrhovými výkresy nebo pseudokódem.
  • Veškerá práce v tištěných poznámkových blocích by měla být provedena perem nebo permanentním inkoustem.
  • Nepoužívejte fixy, které mohou prosakovat papírem v papírovém sešitu.
  • Zdokumentujte výzkum a citujte všechny zdroje.
  • Ukažte všechny matematické práce, nejen odpovědi.
  • Stránky by se neměly přidávat ani odstraňovat z tištěného nebo elektronického poznámkového bloku.
  • Opravte chyby v tištěném poznámkovém bloku přeškrtnutím jednoho řádku; I soudci chtějí vidět chyby.
  • Přílohy, jako jsou obrázky nebo výtisky, by měly být nalepeny páskou nebo nalepeny v papírovém sešitu. K příloze by měl být připojen písemný záznam, který potvrdí její zápis do knihy.
  • Zdokumentujte neúspěchy a špatné obraty, nejen úspěchy a finálního robota.
  • Vývoj kódu by měl být dokumentován spolu s vývojem robotů.