Hogyan írjunk műszaki előírásokat (képekkel)

Tartalomjegyzék:

Hogyan írjunk műszaki előírásokat (képekkel)
Hogyan írjunk műszaki előírásokat (képekkel)

Videó: Hogyan írjunk műszaki előírásokat (képekkel)

Videó: Hogyan írjunk műszaki előírásokat (képekkel)
Videó: How To Write A Project Specification 2024, Március
Anonim

A műszaki specifikáció olyan dokumentum, amely elmagyarázza, mit tesz egy termék vagy projekt, és bemutatja, hogyan lehet elérni a célokat. Meg kell ismertetnie az ügyfelekkel és a csapattal a megoldani kívánt problémákat, a termék vagy projekt céljait és követelményeit. A dokumentum leírja az elvégzendő munkát, és természetes, hogy a projekt végrehajtása során újraírásra kerül.

lépések

Rész 1 /3: A cím megírása

Műszaki leírás írása 1. lépés
Műszaki leírás írása 1. lépés

1. lépés. Írja be a projekt nevét az első sorba, 14 vagy 16 méretű sans serif betűtípussal

A betűméretnek nagyobbnak kell lennie, hogy könnyebben olvasható legyen és kiemelkedjen a szöveg többi részétől. Indokolja a címet, vagy helyezze középre.

A vállalatnak vagy felettesének olyan sablont kell biztosítania, amely megmutatja, hogyan kell írni a címsort. Ha van sablon, kövesse azt

Tudtad?

A Sans serif betűtípusok nem rendelkeznek kötőjelekkel és kiterjesztésekkel a betűtövek végén, így azok modernebbnek tűnnek. A leggyakoribb példák az Arial, a Calibri és a Verdana.

Műszaki leírás írása 2. lépés
Műszaki leírás írása 2. lépés

2. lépés. Írja be a dátumot a projekt neve alá 12 -es méretű sans serif betűtípussal

Hagyjon ki egy sort, és csökkentse a betűméretet 12 -re, de ne változtassa meg a betűtípust. Adja meg a dátumot hagyományos módon: z év y hónapjának x napja.

  • Ha van sablon, olvassa el, hogy a dátumot a megfelelő formátumban kapja meg.
  • A dátum nagyon fontos, mert lehetővé teszi, hogy megtudja, melyik a dokumentum legújabb verziója.
Műszaki leírás írása 3. lépés
Műszaki leírás írása 3. lépés

Lépés 3. Írja be a „Szerző” szót és a szerző nevét a dátum alá

Hagyjon ki egy másik sort, és írja be a "Szerző" szót, majd egy kettőspontot. A dokumentum készítésekor adja meg nevét. Csak írja be a nevét, még akkor is, ha a munka egy csoportos megbeszélés eredménye.

Egy műszaki specifikációnak mindig egyetlen szerzővel kell rendelkeznie, még akkor is, ha csapatmunka. A szerző az a személy, aki írja a dokumentumot

Műszaki leírás írása 4. lépés
Műszaki leírás írása 4. lépés

4. lépés: Írja be a „Csapat” -t és a projekttagok nevét

A következő sorba írja be a „Csapat” és egy kettőspontot. Sorolja fel azokat az embereket, akik a projekten vagy a terméken dolgoznak.

  • Amellett, hogy hitelt ad a csapattagoknak, ez egy módja annak, hogy megmondja az embereknek, kihez kell fordulniuk, ha kérdéseik vannak a műszaki specifikációval kapcsolatban.
  • Ha egyedül dolgozott a projekten, hagyja ki ezt a lépést.

Rész 2 /3: A műszaki specifikáció vázlata

Műszaki leírás írása 5. lépés
Műszaki leírás írása 5. lépés

1. lépés. Írjon rövid összefoglalót a projektről vagy a termékről

Indítsa el a dokumentumot egy összefoglalóval arról, hogy mit csinál. Írja be az „Összefoglaló” részt. Írja le a problémát, adjon alapvető elképzelést a termékről vagy projektről és funkciójáról. Ezután magyarázza el, hogyan kívánja elérni a végső célt, és mutasson be néhány részletet. Említse meg a releváns marketing vagy műszaki dokumentumokat, és végül becsülje meg a termék vagy projekt befejezéséhez szükséges időt.

Írjon valami hasonlót: „A jelenlegi utazási rendszer az utasok két vonalon való koncentrálódását, a harmadik alulhasznosítását okozza. Lehetőség van arra, hogy az interneten csak két buszvonal utazását tervezze meg, de a másik továbbra is papírtérképekkel és telefonnal működik. Ez a modell az utasok számának csökkenését és a vállalat bevételeinek csökkenését okozza, amint azt a 2019. szeptemberi jelentés is mutatja. Azt javasoljuk, hogy a jelenlegi rendszereket egyesítsék egyetlen rendszerré, amely lehetővé teszi az internet -hozzáférést a három buszvonalhoz. Így az utasok könnyebben és gyorsabban utazhatnak, és pontosan tudják, mikor érkezik a busz a megállóba. Ezenkívül közvetlenül a kapcsolatfelvételi funkcióval is jelenthetik a problémákat.”

Műszaki leírás írása 6. lépés
Műszaki leírás írása 6. lépés

2. lépés Készítsen egy részt a célkitűzésekről, ha nem szerepel az összefoglalóban

Írja be a „Célok” címet, és röviden írja le, mit szeretne elérni a projekttel vagy a termékkel. Kezdje a szöveget a szakasz bevezetésével, és sorolja fel a célokat egy tételes vagy számozott listában.

  • Ha az összefoglalóban bemutatta a célkitűzéseket, akkor ezt a részt nem kell elvégeznie, kivéve, ha a vállalat ezt megköveteli.
  • Írjon valami hasonlót: „Az új rendszer a következőket tartalmazza: 1) útvonaltervező eszköz; 2) a busz földrajzi helyfüggvénye; 3) az utasok kommunikációs módja a problémákról.”
Műszaki leírás írása 7. lépés
Műszaki leírás írása 7. lépés

3. lépés: A termékkövetelményeket külön részbe írja be

Írja be a „Termékkövetelmények” címet, és írja le, mi szükséges a probléma megoldásához. Használja a témák listáját, és ne aggódjon a szakasz bevezetése miatt.

Például: „1) Az útvonaltervező biztosítja, hogy az utasok ne csak néhány vonalra koncentráljanak; 2) Az érintkeződoboz olyan eszköz, amely megkönnyíti az utasok kétségeinek megoldását.”

Műszaki leírás írása 8. lépés
Műszaki leírás írása 8. lépés

4. lépés. Magyarázza el, mi tartozik a projekt hatókörébe

Adja meg a „Hatókörön kívül” szakasz címét. Ne írjon bevezető bekezdéseket, hanem egyszerűen azoknak a dolgoknak a listáját, amelyeket nem tesznek meg a probléma megoldása érdekében, például, hogy milyen munkát nem végeznek el, milyen megoldásokat tart nem megfelelőnek, és milyen tulajdonságokkal rendelkezik a termék vagy projekt. Legyen nagyon specifikus, hogy a fogyasztók és a személyzet jól értse az üzenetet.

Írjon valami ilyesmit: „1) Az új rendszer nem változtatja meg a buszvonalak útvonalát; 2) Számítógépet vagy képernyőt nem helyezünk el a buszmegállókban, ezért az utasoknak saját mobil eszközeiket kell használniuk; 3) Nem garantáljuk a probléma azonnali megoldását csak a rendszer megváltoztatásával; 4) Az utasokat nem veszik fel a ház ajtaján.”

Választási lehetőség:

gyakori, hogy a szakaszt a műszaki specifikáció végén és az idővonal előtt helyezik el. Állítsa be a kívánt sorrendben, vagy a kifejezetten utasítások szerint.

Műszaki leírás írása 9. lépés
Műszaki leírás írása 9. lépés

5. Lépjen be a „Nyitott kérdések” szakaszba a megoldatlan kérdések megvitatására

A műszaki specifikáció áttekintést nyújt a termékről vagy a kialakításról, hogy jobban tájékoztassa a fogyasztókat, és ugyanazon célok felé terelje a csapatot. Ne aggódjon amiatt, hogy minden részletet át kell néznie, vagy minden problémát meg kell oldania, hanem hozzon létre egy „Nyílt problémák” nevű részt, amely felsorolja a később megoldandó pontokat.

Írja be például: „1) Hogyan fogjuk kezelni a frissítési rendszert? 2) Megváltoztatjuk az útvonalakat, ha problémánk van? 3) A rendszer megjeleníti az információkat más nyelveken? 4) Hogyan szolgáljuk ki azokat az utasokat, akik nem ismerik az új technológiákat?”

Műszaki leírás írása 10. lépés
Műszaki leírás írása 10. lépés

Lépés 6. Mutassa be a tervet a Megközelítés részben

Nevezze el „Terv” vagy „Megközelítés”. Mutassa be, hogyan kívánja megoldani a problémákat vagy a mérlegelni kívánt különböző megközelítéseket, ha a projekt korai szakaszában van. Ismertesse az alkalmazott technológiák és folyamatok kutatását és típusait. Ha lehetséges, illesszen be képeket, grafikonokat és diagramokat, hogy az olvasók könnyebben megértsék. Végül beszélje meg, hogyan fogja lefolytatni a teszteket, és mit tegyen, ha problémái vannak.

  • Ha különböző megközelítéseket és technológiákat kell leírnia, hozzon létre mindegyikhez alszakaszt.
  • Írjon valami ilyesmit: „Együtt fogunk dolgozni az utazástervező csapattal, hogy létrehozzunk egy alkalmazást, amely lehetővé teszi az utasok számára, hogy belépjenek a kívánt úti célba, és automatikusan létrehozzák az útvonalat. A felhasználók megváltoztathatják az útvonalat. A rendszer szöveges frissítéseket küld, hogy segítse az utasokat az útvonal megtalálásában. Néhány ügyfelet bevonunk a tesztelési munkamenetbe, amelyet a bevezetés előtt tartanak. Ha gondok vannak, hajnalban karbantartást végzünk, amikor a buszok nem járnak. Ezenkívül lesz egy további járművünk az utasok felvételére, akik nem tudtak felszállni a buszra, mert tele volt.”

Választási lehetőség:

tartalmazza a terv összefoglalása céljából az „Előkészületek” című részt. Általában opcionális.

Műszaki leírás írása 11. lépés
Műszaki leírás írása 11. lépés

7. lépés. Beszéljen a megfontolt, de végül elvetett lehetőségekről

Ezt a tartalmat helyezze el a terv részlépéseként vagy a dokumentum végén és az idővonal előtt. Írja be a „Megfontolt alternatívák” cím alá, és írja le őket. Magyarázza el, miért utasította el az egyes lehetőségeket.

Írd le így: "Olcsóbbnak tartottuk a legendákkal ellátott színes térképek használatának lehetőségét, de az utasok között nem volt jó az elfogadás, és a tesztcsoport összezavarodott."

Műszaki leírás írása 12. lépés
Műszaki leírás írása 12. lépés

8. lépés. Írja le a termék vagy projekt értékelési módszereit és méréseit

Helyezze a tartalmat egy vagy több szakaszba. Címkézze fel: „Hatás mérése”, „Értékelés” vagy „Mérések”. Magyarázza el egy -két bekezdésben, hogyan fogja biztosítani a megfelelő működést és a célok elérését. Ismertesse a hibák és problémák ellenőrzésének módját is.

  • Beszéljen az alkalmazott elemzési folyamatokról és technológiákról.
  • Mondjon valami ilyesmit: „Összehasonlításokat végezünk a becsült útidő és a tényleges ingázás között, hogy biztosítsuk a menetrendek betartását. Ezenkívül felmérést fogunk végezni az utasokkal, hogy felmérjük az elégedettség mértékét és azonosítsuk a problémákat.”
Műszaki leírás írása 13. lépés
Műszaki leírás írása 13. lépés

9. lépés. Mutassa be, hogyan őrzi meg a biztonságot és a magánéletet

Írja be a „Biztonság és adatvédelem” címet, és magyarázza el, hogyan fogja megvédeni a felhasználókat a digitális támadásoktól. Írja le néhány bekezdésben a kockázatokat és a magánélet védelmének mechanizmusait.

  • Mindig vannak kockázatok és problémák, ezért soha ne mondd, hogy nem léteznek.
  • Írja így: „A felhasználók megadják az aktuális tartózkodási helyet és lakcímet. Profilt hozhatnak létre, és elmenthetik utazási előzményeiket. Titkosítási módszereket és tűzfalat fogunk használni az adatok védelmére.”
Műszaki leírás írása 14. lépés
Műszaki leírás írása 14. lépés

10. lépés. Zárja le a dokumentumot egy idővonallal és az időbélyegek listájával

Az idővonal fontos eszköz a projekt nyomon követéséhez, és megmutatja, hogy pontosan mit és mikor kell megtenni. Adja meg az „Idővonal” címét, és ossza fel a feladatokat. Készítsen listát a témákról minden csapat vagy tag számára.

  • Például a feladatmegosztás magában foglalhatja a „mérnöki csapatot”, a „tervezőcsapatot”, a „marketinget” és a „minőségbiztosítást”.
  • A mérnöki csapat teendők listája tartalmazhat ilyen elemeket: „1) Frissítés kifejlesztése a webhelyhez; 2) Írjon egy utazástervező alkalmazást; 3) Programozzon kapcsolattartó rendszert.”

Rész 3 /3: A műszaki specifikáció véglegesítése

Műszaki leírás írása 15. lépés
Műszaki leírás írása 15. lépés

1. lépés Használjon egyetlen szóközt a dokumentumban, és hagyjon ki egy sort a szakaszok között

Az egyetlen hely csökkenti a műszaki specifikáció méretét, és megkönnyíti a dokumentum kezelését. A bekezdések vagy szakaszok módosításakor csak egy sort hagyjon ki, nehogy felesleges szóközöket adjon hozzá.

Lehetséges, hogy a szervezet konkrét utasításokat ad a formázásra vonatkozóan. Ha igen, kövesse őket

Műszaki leírás írása 16. lépés
Műszaki leírás írása 16. lépés

2. lépés. A dokumentumban használja a többes számú második névmást

Miközben az Ön és csapata által elvégzendő munkáról beszél, mindig használja a „mi” szót. Egy adott csapat vagy személy megemlítésekor adja meg a teljes nevet, hogy a hivatkozás világos legyen. Így objektívebbé válik a műszaki specifikáció.

  • Például jobb, ha azt írjuk, hogy "A specifikációkat szükség szerint frissítjük", mint "A specifikációkat szükség szerint frissítjük".
  • Hasonlóképpen mondja ki: „A mérnöki csapat építi fel az oldalt” vagy „Marta de Sousa lesz a felelős a marketingterv meghatározásáért”.
Műszaki leírás írása 17. lépés
Műszaki leírás írása 17. lépés

3. lépés Használjon világos, tömör és könnyen érthető nyelvet

Ne csiszoljon mondatokat és ötleteket az ilyen típusú dokumentumokban, mert csak az időt és az olvasót pazarolja. Használjon minél kevesebb szót az ötletek didaktikus kifejezésére. Tekintse át a jelentést, és távolítson el minden felesleges szót és ismétlődő kifejezést.

Például: „Olyan weboldalt készítünk, amely lehetővé teszi az utasok számára az utazások megtervezését és a buszút nyomon követését”, változtassa meg a „A webhely lehetővé teszi az utazások megtervezését és a buszút nyomon követését” értéket

Műszaki leírás írása 18. lépés
Műszaki leírás írása 18. lépés

4. lépés Kérje meg munkatársát, hogy tekintse át a dokumentumot, és tegyen javaslatokat vagy kritikákat

Ossza meg a műszaki leírást a csapat tagjaival. Kérje meg őket, hogy jelöljék meg a hibákat, és javasoljanak fejlesztéseket.

Ne mutassa meg a dokumentumot a területen kívüli személyeknek, mert előfordulhat, hogy a személy nem érti a szakértők számára egyszerű dolgokat, és szükségtelen változtatásokat javasol

Műszaki leírás írása 19. lépés
Műszaki leírás írása 19. lépés

5. lépés Nézze át a dokumentumot, ha módosítania kell

Vegye figyelembe a javaslatokat és a kritikákat, amikor újra elolvassa a műszaki leírást. A legfontosabb az, hogy az ügyfelek és a csapattagok könnyen megértsék. Azonban ne aggódjon amiatt, hogy valami tökéletes legyen.

Valószínű, hogy a projekt vagy a termékfejlesztés során frissítenie kell a műszaki előírásokat. Ez egy ideiglenes dokumentum, ezért ne maradjon le arról, amit ír

Műszaki leírás írása 20. lépés
Műszaki leírás írása 20. lépés

6. lépés: A dokumentum kiosztása előtt végezzen egy jó áttekintést

Olvassa el legalább kétszer, és ha lehetséges, hangosan. Fordítson nagyobb figyelmet az elgépelésekre és a szavak jelentésére.

Például óvakodjon attól, hogy „a jelenlegi rendszer nem hatékony” helyett „a jelenlegi rendszer hatékony” -ra változik

Ajánlott: