<

Ebben a fejezetben, könyvtervezés jelenti a könyv különféle, tipikus összetevőinek tartalmát, stílusát, formátumát, kialakítását és sorrendjét. „Komponensek” alatt itt a könyv tényleges részeit vagy oldalait értjük, mint például a kiadásra vonatkozó közlemény, az előszó, a tárgymutató vagy az elülső vagy hátsó borító. A(z) oldaltervezés fejezet, a kifejezés elem utal olyan dolgokra, amelyek gyakorlatilag bárhol egy könyvben többször is előfordulhatnak, például fejlécek, láblécek, táblázatok, illusztrációk, listák, közlemények, kiemelések és így tovább.

A következő áttekintést nyújt egy nyomtatott műszaki könyv tipikus összetevőiről, valamint ezen összetevők tipikus tartalmáról, formátumáról, stílusáról és sorrendjéről. Természetesen egyetlen felhasználói útmutató, műszaki referenciakönyv, gyorsreferencia-dokumentum vagy más hasonló anyag sem rendelkezik valójában minden ilyen elemmel pontosan úgy megtervezve és ilyen sorrendben, ahogyan azt éppen olvasni fogja. Ehelyett ez az áttekintés a lehetőségek áttekintését adja—mondjuk a lehetőségek skáláját.

Megjegyzés: Jelenleg csak egy példánk van. Felhasználói útmutató FrameMakerben készült, majd PDF‑be exportálták. Hiányzik belőle egy szószedet, de egy tipikus felhasználói útmutató összes többi eleme a helyén van. (Nem tudom, mit jelent az a "d" a "Filepad"-ben!) Vegye figyelembe, hogy nem felel meg néhány, az alább felsorolt betűtípus- és margókövetelménynek.

Mielőtt nekilátsz az alábbiak olvasásának, szerezz be néhány hardver- és szoftverkönyvet, hogy össze tudd hasonlítani azok tartalmát, stílusát, formátumát és sorrendiségét azzal, amit itt tárgyalunk.

Ha ennél is részletesebb információra van szüksége, tekintse meg a következő két iparági forrást:

Ezeknek a könyvelemeknek példáit megtekintheti. Műszaki dokumentáció tervezése.

Elülső és hátsó borítók

Azok a termékdokumentumok, amelyeket fizető vásárlók számára készítenek, általában szépen megtervezett borítóval rendelkeznek, még akkor is, ha belül a könyv minősége silány, olcsó kategóriájú. A borítón általában a következő elemek egy részét vagy mindegyikét szokta látni:

Nehéz lehet kitalálni egy jó formátumot a cég nevéhez, a termék nevéhez és a könyvcímhez. Néha ezek akár egy egész bekezdésnyi szöveget is kitesznek! A vállalatok meglehetősen megosztottak abban, hogy feltüntessék-e a verzió- és kiadásszámokat a borítón—egyesek igen; mások nem. Szinte mindig azonban látni fogod a platform megjelölését—legyen szó Macintoshra, PC-re, UNIX-ra szóló termékről, és így tovább.

A nyomtatott felhasználói útmutatók és kézikönyvek hátlapja általában nagyon egyszerű. Általában tartalmazza a könyv rendelési számát, a cég nevét a megfelelő védjegyjelezéssel, a szerzői jogi szimbólumot és a könyv tulajdonjogára vonatkozó megfogalmazást, valamint egy nyilatkozatot arra vonatkozóan, hogy melyik országban nyomtatták a könyvet. A hátlapon vonalkódokat is talál. Ellenőrizze, hogy a szoftvere képes-e vonalkódot generálni—egyszerűen hozzáfér a vonalkód-segédprogramhoz, beírja a könyv rendelési számát, és a segédprogram létrehozza a vonalkódot.

Címlap

A címoldal általában az elülső borító másolata, de bizonyos elemek hiányoznak róla. Jellemzően kihagyják az illusztrációkat/grafikákat, a cég- vagy terméklogókat és a szlogeneket. Néhány műszaki kiadvány a címoldalt teljesen el is hagyja a látszólag felesleges ismétlődés miatt. (És egy 20 000 példányos nyomtatásnál egyetlen oldal nagyon sokat számít!)

Kiadási értesítés

A kiadási közlemény általában a műszaki kiadványokban előforduló folyamatos szöveg első megjelenése, bár rendszerint kisebb betűméretű. A címlap hátoldalán található. Ha a műszaki kiadó a takarékos és környezetbarát megközelítést alkalmazza, és elhagyja a címlapot, a kiadási közlemény az elülső borító belső oldalán fog megjelenni.

Senki sem szeret apróbetűs részt olvasni, de nézze meg azokat a nyilatkozatokat, amelyeket általában egy kiadói közlemény tartalmaz:

Felelősségkizárások

Lásd a szakaszt erről kiadási értesítések, ahol a felelősségkizáró nyilatkozatokat általában elrejtik. Ha egy terméknek vagy annak kiadványának egész külön oldalt kell szentelni a felelősségkizáró nyilatkozatainak, akkor nem veszem meg!

Védjegyek

Bár sok vállalat felsorolja saját és más vállalatok védjegyeit a Kiadási közlemény, egyesek inkább külön oldalon sorolják fel őket, közvetlenül a kiadásról szóló közlemény után. Ezeket az elhelyezési döntéseket szinte kizárólag a cég jogászai hozzák meg; íróként előfordulhat, hogy engedelmeskedned kell, bármennyire is rossz a döntés a könyv formatervezése vagy az írásstílusa szempontjából. Ne feledd, csak azokat a védjeggyel ellátott termékneveket sorolod fel, amelyek abban a konkrét könyvben előfordulnak.

Észre fogod venni, hogy egyes kiadványok a védjegyekkel kapcsolatban szélsőséges óvintézkedéseket tesznek: az első, sőt akár minden előfordulását csillaggal jelölik, vagy lábjegyzetben tüntetik fel egy védjegyzett termék nevét. De ismét: ezek vállalati jogászok utasításai, amelyekhez a műszaki íróknak sajnos be kell rendezkedniük.

Garanciák

További jogi anyagok. Ezek azok a „garanciák”, amelyeket a vállalat a termékére vonatkozóan vállal. Néha ezek a könyv előzetes részeiben jelennek meg; de könyvtervezési szempontból megfelelőbb, ha külön kártyára nyomtatják, és a könyv vagy a termék zsugorfóliájába helyezik. Ismételten, ahogyan a kiadási értesítéseknél, ez olyan szöveg, amelyet egyszerűen „sablonszövegként” behozol, és a könyv megfelelő helyére helyezel.

Azonban legyen tisztában azzal, hogy a vállalatok néha többféle változatot tartanak fenn kiadási értesítésekből, biztonsági közleményekből, garanciákból, kommunikációs nyilatkozatokból és hasonlókból. Íróként meg kell győződnie arról, hogy a megfelelő változatot használja (és hogy kiderítse, melyik a helyes, remek alkalma lesz kimozdulni és sok új embert megismerni a cégnél!). És bármit is tesz, ne változtassa meg ezeknek a sablonszövegeknek a szövegét, akár mennyire is rosszul vannak megírva. A változtatásokat rendszerint a vállalati jogászoknak kell jóváhagyniuk (akik rendszerint kelletlenül járnak el, és csak az ön sok erőfeszítése és hosszú idő elteltével járulnak hozzá).

Biztonsági figyelmeztetések

A hardvertermékekhez tartozó könyvek elején általában van egy biztonsági figyelmeztetéseket tartalmazó szakasz. Ez előfordulhat például a bevezető alcsoportjaként, vagy önálló, külön szakaszként. Ezek a részek általában összegyűjtik a könyvben előforduló összes veszély-, figyelmeztetés- és óvatossági értesítést, és valamilyen logikus módon rendszerezik azokat. De még ezzel az előzetes figyelmeztetéssel is a hardverkönyvek a konkrét értesítéseket ott helyezik el, ahol azok vonatkoznak. (A további információkért lásd: különleges értesítések.)

Kommunikációs nyilatkozatok

A hardverkönyvek szintén megkövetelnek kommunikációs nyilatkozatokat azoknak az országoknak a kormányai által előírtak szerint, ahová ezeket a termékeket szállítják. Az Egyesült Államokban az FCC bizonyos kommunikációs nyilatkozatokat követel meg a hardvertermék „osztályától” függően. Íróként ügyelned kell arra, hogy a dokumentált termékhez a megfelelő kommunikációs nyilatkozatot használd—és hogy egyáltalán ne szerkeszd a nyilatkozatot (a szent jogi szavak!).

Tartalomjegyzék

A tartalomjegyzék (TOC) általában legalább egy második részletességi szintet tartalmaz (a tényleges szövegben szereplő head 1-eket), hogy az olvasók pontosabban megtalálhassák, amire szükségük van. A szerzők, szerkesztők és könyvtervezők általában vitatkoznak a tartalomjegyzék sorrendjéről. Használhatóság szempontjából sokkal jobb a tartalomjegyzéket a könyv elejéhez a lehető legközelebb elhelyezni, ha nem is a könyv legelső oldalán. Jogi szempontból azonban sokan aggódnak amiatt, hogy az összes kommunikációs nyilatkozat, jótállás, szerzői jogi megjegyzés, védjegy és biztonsági közlemény előre kerüljön. Azokon a helyeken, ahol a használhatóság győzedelmeskedik, a könyvek minden lehetséges taktikát bevetnek annak érdekében, hogy ezt a jogi jellegű anyagot eltávolítsák az előszókból: a jótállásokat külön kártyákra nyomtatják és a könyvvel vagy termékkel fóliázzák; a jótállások, kommunikációs nyilatkozatok, védjegyek és ehhez hasonlók a függelékekbe kerülhetnek.

Gondot okoz egy szépen formázott tartalomjegyzék létrehozása? Lásd Készítsen professzionális megjelenésű tartalomjegyzéket.

Ábrák jegyzéke

A hétköznapi felhasználók számára készült műszaki kézikönyvek általában nem tartalmaznak ábrajegyzékeket. Valójában maguk az ábrák általában nem rendelkeznek teljes körű ábracímekkel. De ez nem jelenti azt, hogy az ábrajegyzéknek ne lenne helye a műszaki kézikönyvekben. Mindez attól függ, hogy ki az olvasó és mik a szükségletei—valamint a könyv tartalma is. Ha a könyv táblázatokat, illusztrációkat, diagramokat, grafikonokat és egyéb, az olvasók által közvetlenül megkeresni kívánt elemeket tartalmaz, az ábrajegyzék indokolt.

Előszó

Az előszó funkciója az, hogy felkészítse az olvasókat a könyv elolvasására. Ezt a következőképpen teszi:

A hagyományos könyvkiadásban az előszó a tartalomjegyzék előtt áll; de, ahogy azt korábban a tartalomjegyzék Szakasz, a technikai kiadványszerkesztéssel foglalkozó emberek azt szeretnék, hogy a tartalomjegyzék használhatósági okokból korábban szerepeljen a könyvben.

Test fejezetek

Ó igen, és ezekben a könyvekben tényleges szöveg is található—nem minden csupán bevezető anyag! Itt nincs sok más mondanivaló, csak annyi, hogy a legtöbb műszaki könyv fejezetekre vagy szakaszokra tagolódik, és egyes esetekben részekre. Lásd a ...-ról szóló fejezetet oldaltervezés az olyan elemek formátumára, stílusára és tervezésére vonatkozó problémák esetén, mint a fejléc, lábléc, címsorok, listák, értesítések, táblázatok, grafikák, kereszthivatkozások és kiemelések.

Függelékek

Ahogy tudod, a függelékek olyan anyagok számára valók, amelyek egyszerűen nem tűnnek illeszkedni a könyv fő részébe, de a könyvből sem hagyhatók ki. A függelékek gyakran nagy, nehezen kezelhető táblázatok helyei. Néhány műszaki kiadványban például garanciák találhatók a függelékekben. Formátum szempontjából a függelék ugyanolyan, mint egy fejezet—kivéve, hogy „Appendix A” vagy valami hasonló nevet kap, és a fejlécek és láblécek igazodnak ehhez a különböző számozási és elnevezési konvencióhoz (A-1, A-2 és így tovább az „Appendix A” oldalain).

Fogalomtár

Néhány műszaki kiadvány tartalmaz egy olyan részt, amely a szakszavakat és azok meghatározásait tartalmazza. Vegyük észre, hogy a legtöbb szójegyzék két oszlopos elrendezést használ. Általában minden kifejezés és annak meghatározása külön bekezdést képez, a kifejezés kisbetűs (hacsak nem tulajdonnév) és félkövér, utána pont, majd a meghatározás normál, római betűvel. Figyeljük meg azt is, hogy a meghatározások általában nem teljes mondatok. A jó szójegyzék-meghatározásoknak a formális mondatdefiníciós technikát kellene alkalmazniuk, ahogyan azt a Definíciós fejezet ennek az online szövegnek a. Több meghatározást általában arab számokkal zárójelben jelölnek. A szószedet bekezdései továbbá tartalmaznak Látni hivatkozások a preferált kifejezésekre és Lásd még hivatkozások a kapcsolódó kifejezésekre.

Tárgymutató

Indexek általában szintén két hasábosak és szintén tartalmaznak Látni hivatkozások a preferált kifejezésekre és Lásd még hivatkozások a kapcsolódó kifejezésekre. Lásd a fejezetet a indexelés a jó indexek létrehozására vonatkozó folyamatokhoz és irányelvekhez.

Olvasói válasz űrlap

Az internet és a közösségi média felemelkedése előtt néhány műszaki kiadvány papíralapú űrlapot tartalmazott, amely lehetővé tette az olvasók számára, hogy visszajelzéseket, kérdéseket és értékeléseket küldjenek a könyvről. Természetesen kiderült, hogy ezek az űrlapok gyakrabban váltanak ki panaszokat a könyv által dokumentált termék hibás működésére. Az internet elterjedésével ezek az űrlapok átkerültek az online térbe, és a könyvek csupán az online elérhetőségükre hivatkoznak.

Könyvtervezés és tördelés

Jellemzően a hardver- és szoftvergyártók által készített felhasználói útmutatók és kézikönyvek meglehetősen puritán és fapados módon vannak megtervezve. A csúcstechnológiai vállalatok néha kilenchavonta fejlesztenek új verziókat és kiadásokat termékeikből. Ebben a kontextusban a kifinomult dizájn egyszerűen nem praktikus. Íme néhány tipikus elrendezési és dizájnjellemző, amelyet láthat:

Megjegyzés: Ezzel lezárul a nyomtatott könyvről folytatott megbeszélés. komponensek. A nyomtatott könyvek tervezésének ezt az áttekintését kiegészítve, lásd a fejezetet a oldaltervezés, amely lefedi elemek például fejlécek és láblécek, címsorok, listák, különleges értesítések, táblázatok, grafikák, kiemelések, kereszthivatkozások és még sok más.

Értékelném a gondolatait, reakcióit és kritikáját ezzel a fejezettel kapcsolatban: a válaszod.