Technikai írás

Ez a fejezet a javaslatra összpontosít – arra a fajta dokumentumra, amelynek segítségével Ön vagy a szervezete jóváhagyást vagy megbízást kap egy projekt elvégzésére.

A műszaki írás tanfolyamon a javaslatfeladat lehetőséget ad arra, hogy egy konkrét, megnevezett közönségnek bemutasson egy ötletet, amely az adott vállalat, szervezet, központ vagy más vállalkozás egy bizonyos aspektusának javítására irányul. Bármilyen témát is választasz, képesnek kell lenned alapos tudományos kutatást végezni, amelyet beépítesz a végső jelentésedbe.

A pályázat tervezésének megkezdéséhez emlékezz az alapvető definícióra: a pályázat egy ajánlat vagy ajánlat egy projekt elvégzésére valakinek. A javaslatok más elemeket is tartalmazhatnak – műszaki hátteret, ajánlásokat, felmérések eredményeit, a megvalósíthatóságra vonatkozó információkat stb. De a javaslatot az teszi javaslattá, hogy arra kéri a hallgatóságot, hogy hagyja jóvá, finanszírozza, vagy adjon engedélyt a javasolt projekt elvégzésére.

A javaslatnak olyan információkat kell tartalmaznia, amelyek lehetővé teszik, hogy a javaslat hallgatósága eldöntse, hogy jóváhagyja-e a projektet, jóváhagyja-e vagy felbérelje-e Önt a munka elvégzésére, vagy mindkettőt. A sikeres pályázat megírásához képzelje magát a célközönség – a pályázat címzettje – helyébe, és gondolja át, milyen információkra lenne szüksége annak a személynek ahhoz, hogy bízzon abban, hogy ön végzi el a projektet.

Egyszerű összezavarodni a pályázatokkal kapcsolatban, vagy legalábbis azzal a pályázattípussal kapcsolatban, amelyet ezen az órán írni fog. Képzeld el, hogy van egy fantasztikus ötleted valamilyen új technológia telepítésére ott, ahol dolgozol, és írsz egy dokumentumot, amelyben elmagyarázod, hogyan működik, bemutatod az előnyöket, majd sürgeted a vezetőséget, hogy telepítsék be. Ez egy javaslat? Önmagában ez nem lenne teljes körű javaslat. Inkább olyan, mint egy megvalósíthatósági jelentés, amely megvizsgálja egy projekt előnyeit, majd javaslatot tesz mellette vagy ellene. Ahhoz azonban, hogy ez a dokumentum javaslattá váljon, mindössze olyan elemeket kellene hozzáadni, amelyek a vezetőség jóváhagyását kérik a projekt folytatásához. Ezen túlmenően, ebben az osztályban az egyik ilyen elem a tudományos kutatás. Természetesen egyes pályázatíróknak el kell adniuk az általuk javasolt projekteket, de a pályázatoknak minden esetben el kell adniuk az írót (vagy az író szervezetét) mint a projekt megvalósítóját.

A pályázatok típusai

Megfontolandó, hogy milyen helyzetekben fordulnak elő pályázatok. Egy vállalat kiküldhet egy nyilvános hirdetményt, amelyben ajánlatokat kér egy adott projektre. Ez a nyilvános hirdetmény – az úgynevezett ajánlatkérés (RFP) – történhet weboldalakon, e-maileken, a közösségi médiában, újságokban vagy szaklapokban. A projekt iránt érdeklődő cégek vagy magánszemélyek ezután ajánlatokat írnának, amelyekben összefoglalják képzettségüket, a projekt ütemezését és költségeit, valamint megvitatják a projekthez való hozzáállásukat. Az ajánlatok címzettje ezután értékelné azokat, kiválasztaná a legjobb jelöltet, majd szerződést dolgozna ki.

Az ajánlatok azonban sokkal kevésbé formálisan is születnek. Képzeljük el, hogy érdekli egy projekt a munkahelyén (például annak vizsgálata, hogy milyen előnyökkel járna valamilyen új technológia bevezetése a termelékenység növelése érdekében). Képzelje el, hogy találkozott a felettesével, és megpróbálta meggyőzni őt erről. Lehet, hogy azt válaszolja: “Írj egy javaslatot, és én majd bemutatom a felső vezetésnek”. Ez inkább hasonlít arra a fajta javaslatra, amelyet egy műszaki írás tanfolyamon fog írni.

A legtöbb javaslat több kategóriába sorolható:

  • Belső, külső: A szervezeten belüli valakinek (vállalkozásnak, kormányhivatalnak stb.) szóló javaslat belső javaslat. A belső ajánlatok esetében előfordulhat, hogy nem kell bizonyos szakaszokat (például a képesítéseket) vagy nem kell annyi információt tartalmaznia. A külső ajánlat egy különálló, független szervezet vagy személy által egy másik ilyen szervezetnek írt ajánlat. Tipikus példa erre a független tanácsadó, aki egy másik cégnek tesz ajánlatot egy projekt elvégzésére. Valószínűleg e kétféle ajánlat közül az egyiket fogja megírni ezen az órán, és ez lehet felkéréses vagy felkérés nélküli, amint azt az alábbiakban kifejtjük.
  • felkéréses, felkérés nélküli: A felkéréses pályázat olyan pályázat, amelyben a címzett kérte a pályázatot. Jellemzően egy vállalat postai úton küldi ki az ajánlatkéréseket (RFP), vagy közzéteszi azokat valamilyen hírforrásban. De az ajánlatokat nagyon helyi szinten is lehet kérni: például elmagyarázhatod a főnöködnek, milyen nagyszerű dolog lenne egy új technológia bevezetése az irodában; a főnököd esetleg érdeklődni kezd, és megkér, hogy írj egy ajánlatot, amelyben felajánlod, hogy hivatalos tanulmányt készítesz az ötletről. A kéretlen ajánlatok azok, amelyekben a címzett nem kért ajánlatot. A kéretlen ajánlatok esetében néha meg kell győznie a címzettet arról, hogy létezik egy probléma vagy szükséglet, mielőtt elkezdheti a javaslat fő részét. Az ezen az órán látott műszaki írói projektek többsége kéretlen ajánlat volt.

A javaslat tipikus forgatókönyvei

Egyikük talán még soha nem gondolt arra, hogy egy életképes javaslat alapján műszaki jelentést készítsen. A feladatlapon több mintatéma is szerepel; íme néhány további ötlet:

  • Képzeljük el, hogy egy vállalatnak problémája van, vagy valamilyen fejlesztést szeretne végrehajtani. A vállalat ajánlatkérést küld ki; ön megkapja az ajánlatot, és egy javaslattal válaszol. Ön felajánlja, hogy bejön, megvizsgálja, interjút készít, ajánlásokat tesz – és mindezt egy jelentés formájában bemutatja.
  • Egy szervezet szemináriumot szeretne tartani az Ön szakértelmével. Ön ajánlatot ír a szeminárium megtartására – a csomagban szerepel egy útmutató vagy kézikönyv, amelyet a szemináriumon részt vevők kapnak.
  • Egy ügynökség most kezdett el használni egy új online adatrendszert, de a felhasználói kézikönyv technikailag bonyolult és nehezen olvasható. Ön ajánlatkérést kap ettől az ügynökségtől egy egyszerűsített útmutató vagy indítási útmutató megírására.
  • Tegyük fel, hogy egy bizonyos témára összpontosító nonprofit szervezet szeretne egy tanácsadót, aki kézikönyvet vagy útmutatót írna a tagsága számára. Ez a dokumentum a tagok számára érthető módon fogja bemutatni az adott témával kapcsolatos információkat.

Nem minden kutatási téma alkalmas műszaki írásra. Az értékeken és meggyőződéseken alapuló témák nem tartoznak a műszaki kategóriába. A történelmi és irodalmi témák nem minősülnek. Mindig egyeztessen az oktatójával a témaötleteiről, mielőtt hozzákezd a projektjéhez.

Mellett tartsa szem előtt, hogy tudományos kutatásokat kell beépítenie a zárójelentésébe, olyan témát válasszon, amelyhez könnyen talál ilyen anyagot. Bár az interjúk és más, első kézből származó források gyakran értékesek egy jelentéshez, egy olyan jelentés, amely nagymértékben ezekre a forrásokra támaszkodik, nem fogja teljesíteni a kurzus eredményeit.

A pályázatok gyakori szakaszai

A következőkben áttekintjük azokat a szakaszokat, amelyekkel gyakran találkozhat a pályázatokban, amelyeket ebben az órában memoár formátumban nyújtanak be. Ne feltételezze, hogy mindegyiknek szerepelnie kell a ténylegesen megírt pályázatban, és azt sem, hogy az itt bemutatott sorrendben kell szerepelniük. Nézze meg a feladatlapot, és fontolja meg a témájára jellemző másfajta, egyedi információkat, amelyeket az adott javaslatnak tartalmaznia kell.

Amíg ezt a javaslatokról szóló fejezetet olvassa, nézze meg az aktuális heti egységmappánkban megosztott javaslat-jegyzetmintát. Ismét ne feledje, hogy az itt tárgyalt szakaszok nem mindegyike jelenik meg a példákban, de a legtöbbjük igen.

Bevezetés. Gondosan tervezze meg a javaslatának bevezetőjét. Győződjön meg róla, hogy a következő dolgok mindegyikét megteszi (de nem feltétlenül ebben a sorrendben), amelyek az Ön konkrét javaslatára vonatkoznak:

  • Határozza meg, hogy a feljegyzés tartalma egy konkrét projektre vonatkozó javaslat.
  • Tervezzen ki legalább egy rövid motiváló kijelentést, amely arra ösztönzi a címzettet, hogy olvassa tovább, és fontolja meg a projekt jóváhagyását (különösen, ha kéretlen vagy versenyeztetett pályázatról van szó).
  • Adjon áttekintést a pályázat tartalmáról.

A probléma, a lehetőség vagy a helyzet háttere. A gyakran közvetlenül a bevezetés után előforduló háttérszakasz azt tárgyalja, hogy mi okozta a projekt szükségességét – milyen probléma, milyen lehetőség van a dolgok javítására, mi az alaphelyzet. Például egy óvodalánc vezetőségének szüksége lehet arra, hogy minden alkalmazottja ismerje az újraélesztést, mert az új állami előírások ezt megkövetelik, vagy egy kelet-oregoni fenyőfás terület tulajdonosa szeretné elérni, hogy a terület eladható fát termeljen a környezet tönkretétele nélkül.

Míg a javaslat megnevezett célközönsége nagyon jól ismerheti a problémát, a háttérrész megírása hasznos a probléma sajátos szemléletének bemutatásához. Továbbá, ha a pályázat kéretlen, a háttérszakasz szinte követelmény – valószínűleg meg kell győznie a közönséget arról, hogy a probléma vagy lehetőség létezik, és hogy foglalkozni kell vele.

A javasolt projekt előnyei és megvalósíthatósága. A legtöbb pályázat röviden tárgyalja a javasolt projekt megvalósításának előnyeit vagy hasznát. Ez egyfajta érvként szolgál a projekt jóváhagyása mellett. Néhány javaslat a projekt sikerének valószínűségét is tárgyalja. Egy kéretlen pályázat esetében ez a szakasz különösen fontos – Ön megpróbálja “eladni” a közönségnek a projektet.

A javasolt munka leírása (a projekt eredményei). A legtöbb pályázatban le kell írni a javasolt projekt végtermékét. Egy műszaki írástanfolyamon ez azt jelenti, hogy le kell írni a megírni javasolt írásos dokumentumot, annak célközönségét és célját; vázlatot kell adni; és olyan dolgokat kell megvitatni, mint a terjedelem, a grafika, a kötés és így tovább. Az Ön által meghatározott forgatókönyvben lehet más munka is, például képzési szemináriumok tartása vagy folyamatos szolgáltatás nyújtása. Ebben a korai szakaszban még nem biztos, hogy mindent tudsz, ami a projekted befejezéséhez szükséges, de legalább elképzelésednek kell lennie néhány szükséges lépésről.

Módszer, eljárás, elmélet. Néhány pályázatban el kell magyaráznia, hogyan fogja elvégezni a javasolt munkát. Ez további meggyőző elemként hat; megmutatja a hallgatóságnak, hogy a projekthez megalapozott, átgondolt megközelítéssel rendelkezik. Emellett annak bizonyítására is szolgál, hogy Ön rendelkezik a terület ismereteivel a projekt megvalósításához.

Az ütemterv. A legtöbb pályázat tartalmaz egy olyan részt, amely nemcsak a tervezett befejezési dátumot, hanem a projekt legfontosabb mérföldköveit is bemutatja. Ha egy nagy, több hónapra kiterjedő projektet hajt végre, az ütemtervben szerepelnek azok a dátumok is, amelyeken az előrehaladási jelentéseket fogja leadni. Ha nem tud konkrét dátumokat megadni, adja meg a projekt egyes fázisainak időtartamát.

Költségek, szükséges erőforrások. A legtöbb pályázat tartalmaz egy olyan részt is, amely részletezi a projekt belső vagy külső költségeit. Külső projektek esetében szükség lehet az óradíjak, a tervezett órák, a berendezések és kellékek költségeinek stb. felsorolására, majd a teljes projekt összköltségének kiszámítására. A belső projektek természetesen nem ingyenesek, ezért továbbra is fel kell sorolnia a projekt költségeit: a projekt elvégzéséhez szükséges órákat, a felhasznált felszereléseket és kellékeket, a szervezeten belül más személyek segítségét és így tovább.

Következtetések. A javaslat utolsó bekezdésének vagy szakaszának vissza kell vezetnie az olvasót a projekt pozitív aspektusaira való összpontosításhoz. A záró szakaszban arra ösztönözheti őket, hogy vegyék fel Önnel a kapcsolatot a projekt részleteinek kidolgozása érdekében, emlékeztetheti őket a projekt megvalósításának előnyeire, és esetleg még egy utolsó érvet hozhat fel amellett, hogy Ön vagy az Ön szervezete a megfelelő választás a projektre.

Speciális projektspecifikus szakaszok. Ne feledje, hogy az előző szakaszok az írásos pályázatokban tipikus vagy általános, nem pedig abszolút követelmények. Mindig tegye fel magának a kérdést, hogy mire lehet még szüksége a közönségének ahhoz, hogy megértse a projektet, annak szükségességét, a belőle származó előnyöket, az Ön szerepét a projektben és az Ön képzettségét. Mit kell még látniuk ahhoz, hogy jóváhagyják a projektet és jóváhagyják Önt a projekt elvégzésére?

Speciális megbízási követelmények

Az írási helyzettől függően előfordulhat, hogy az ajánlatának más speciális elemeket is tartalmaznia kell. Ezek közül néhányat az alábbiakban ismertetünk. Megjegyzés: ezen elemek némelyikét valóban megkövetelik a kurzusra vonatkozó előmeneteli jegyzetében; azonban egy valódi műszaki írói szituációban a témavezetője kérheti, hogy a javaslatába a következők valamelyikét is írja bele:

A közönség: Írja le a végső jelentés célközönségét (amely eltérhet a javaslat célközönségétől). Lehet, hogy ki kell térnie arra, hogy kiknek szól a jelentés, milyen címmel és munkakörrel rendelkeznek, milyen technikai háttérrel rendelkeznek, és mennyire képesek megérteni a jelentést.

Információs források: Sorolja fel az információforrásokat; győződjön meg arról, hogy a témához megfelelő információk állnak rendelkezésre; sorolja fel a konkrét könyvek, cikkek, referenciamunkák, másfajta források idézeteit, amelyekről úgy gondolja, hogy hozzájárulnak a jelentéshez.

Grafika: Sorolja fel a grafikákat, amelyekre véleménye szerint a jelentésnek szüksége lesz, típusuk és tartalmuk szerint. (Ha nem jut eszébe olyan, amire a jelentésének szüksége lenne, akkor lehet, hogy nincs jó témája – végezzen ötletbörzét az oktatójával). Ezen az órán grafikákat kell készítenie és beépítenie a végső jelentésébe.

Vázlat: Tartalmazzon egy vázlatot azokról a témákról és altémákról, amelyekről úgy gondolja, hogy a jelentésében szó lesz.

Javaslatok és célközönség

Ne feledje, hogy egy műszaki írás kurzuson a javaslatfeladat több célt is szolgál: (1) némi tapasztalatot szerezhetsz a javaslatírás terén; (2) elkezdheted megtervezni a féléves beszámolódat; (3) az oktatónak lehetősége nyílik arra, hogy együtt dolgozzon veled a projekteden, hogy megbizonyosodjon arról, hogy életképes témád van. A második és a harmadik okból kifolyólag a pályázatnak bizonyos elemeket kell tartalmaznia (amint azt a feladatlapon feljegyezték), amelyek közül néhány nem tűnik megfelelőnek egy valós pályázatban.

Ebben a műszaki írás kurzusban a pályázat egy több hetes kutatási és írási folyamat kezdete, amely számos szakaszon megy keresztül, amíg eljut a végponthoz: a műszaki jelentéshez. A javaslatot e folyamat során csak egyszer nyújtja be. Ezt követően különböző típusú dokumentumokat írsz és nyújtasz be: egy előrehaladási jelentést, egy vázlatot, egy kommentált bibliográfiát, egy grafikai vázlatot, egy jelentéstervezetet és egy zárójelentést. Ügyelj arra, hogy a “javaslat” kifejezést csak akkor használd, ha kifejezetten a projekted kezdeti szakaszára utalsz.

Egy másik pont, amit szem előtt kell tartanod, a javaslatok célközönségére vonatkozik, szemben a jelentések célközönségével, amelyek az írási folyamat későbbi szakaszában jönnek. A pályázatod célközönsége az a személy, aki jóváhagyhatja, támogathatja és esetleg finanszírozhatja a kutatásodat és írásodat. Az Ön által készített végleges jelentés más közönségnek is szólhat. Vegyük például azt a javaslatot, amelyet egy napenergiával foglalkozó vállalat felettesének írt, és amelyben a lakossági napelem-szerelők számára egy irányelvek kézikönyvének elkészítését javasolja. A javaslat célközönsége lehet egy vezető beosztású személy, akinek a technikai ismeretei nagyon széleskörűek lehetnek. Másfelől a végső jelentés célközönsége a technikusok, akiknek speciálisabb ismereteik lehetnek, mint a vezetőnek. A két különböző célközönség számára használt tartalmat és nyelvezetet az írói helyzethez kell igazítani. (Erről bővebben a Célközönségelemzés című fejezetben olvashat.)

A pályázatok felülvizsgálatának ellenőrzőlistája

A pályázat felülvizsgálata és átdolgozása során tartsa szem előtt a következőket:

  • A megfelelő formátumot használja. Ne feledje, hogy ezen az órán a javaslatot jegyzet formátumban írja.
  • Írjon világos összefoglalót (vagy bevezetést) a javaslata témájáról.
  • Határozza meg, hogy pontosan mit is javasol.
  • Gondoskodjon arról, hogy egy jelentés – egy írásos dokumentum – valamilyen módon részt vegyen a javasolt projektben. Ne feledje, hogy ezen a műszaki írás kurzuson egyszerre gyakoroljuk egy javaslat megírását, mint amilyenek a való világban készülnek, és egy főiskolai szintű kutatási projekt elvégzését.
  • Gondoskodjon arról, hogy a javaslat szakaszai logikus, természetes sorrendben legyenek, és hogy helyesen használja az alcímeket és a felsorolásjeleket (és bármely más formázási stílust).
  • A javaslatot a megnevezett közönségének címezze – nem az oktatójának.

A fejezethez tartozó információk

.

Vélemény, hozzászólás?

Az e-mail-címet nem tesszük közzé.