Oldalterv a különböző embereknek mást jelent, de itt a tipográfia és a formázás használatát jelenti, ahogy azt a professzionálisan tervezett dokumentumokban látjuk.
Itt a technikai dokumentációra összpontosítunk, ami szerény, funkcionális tervezést jelent.
Amit itt látsz, annál még részletesebb információkért konzultálj e két ipari szabványos forrással:
- Sun Műszaki Kiadók. Olvasd el először! Bármelyik legutóbbi kiadás. Prentice Hall.
- Microsoft Vállalat. Microsoft Kézikönyv a Műszaki Kiadványok Stílusához. Bármelyik legfrissebb kiadás. Microsoft Press.
Fejléc és lábléc
Az emberek gyakran összekeverik a fejlécet a címsorokkal. A címsorokat, amelyeket a fejezetek Milyen kifejezések fordulnak elő? a test területén egy dokumentum. A fejléc azok a kifejezések és esetleg oldalszámok, amelyek előfordulnak a fejléc területén a dokumentum alján található. A láblécek olyan kifejezések és esetleg oldalszámok, amelyek előfordulnak a lábléc területén Egy dokumentum. Egy gyakori hiba, és egy nagy, hogy a dokumentum címét a fejléc területére helyezik, ami miatt az minden következő oldalon megjelenik.
Nézd meg egy tipikus dokumentum oldalának diagramját:
Egy elterjedt oldalterv az, hogy a dokumentum címe és az oldalszám a lábléc területén helyezkedik el. Alternáló formátumban a bal oldalon az oldalszám és a dokumentum címe, ebben a sorrendben látható; a jobb oldalon pedig a dokumentum címe és az oldalszám, ebben a sorrendben.
Címek
Az alábbiakban bemutatjuk a címsorokra vonatkozó néhány alapvető irányelvet. Részletesebb áttekintésért lásd a címet a címek az online tankönyvben.
- Használj bőségesen címsorokat, talán egy címsort minden két-három bekezdéshez. Természetesen a címsorokat túllőni is lehet: sok címsor, amelyhez csak egy vagy két mondat tartozik, nem működik.
- Tervezzen címsorokat úgy, hogy világosan jelezzék a szintjüket. Használjon betűméretet, betűstílust, színt, félkövér, dőlt, igazítást úgy, hogy a címsor szintje nyilvánvaló legyen. (A címsorok "szintjei" olyanok, mint az egy vázlat szintjei: az első szint megfelel a római számoknak; a második szint, a nagybetűknek; és így tovább.)
- Tegyél a fejezetcímek leíróvá az általuk bevezetett szakaszokról. Olyan címek, mint a "Technikai Háttér", senkinek nem mondanak semmit.
- Készíts címeket párhuzamos A párhuzamok fontos nyomokat adnak az olvasóknak arról, hogy a szakasz hasonló-e a megelőzőkhöz.
- Kerüld az „egyedüli címsorokat”—ugyanaz a koncepció, mint amikor van egy „A” „B” nélkül vagy egy „1” „2” nélkül a vázlatokban.
- Kerüld a "többlet címsorokat"—amikor két vagy több egymás utáni címsor van bekezdés nélküli.
- Kerüld a főcímek utáni mondatokban a névmások használatát. Ha van egy cím, mint például "A szoftver konfigurálása", ne kövesd azt olyan mondattal, mint például "Ez a következő szakasz..."
- Fontolja meg a "lógó fej" formátum használatát, hogy a címek jobban kiemelkedjenek, és csökkentsék a normál szöveg sorainak hosszát. A lógó fej kialakításában a címek egy része vagy mind a bal margón helyezkedik el, míg minden szöveg egy vagy két hüvelykkel behúzott.
- Fontolja meg, hogy "futó" címsorokat használjon a legalacsonyabb szintű címsorokhoz. Nehéz lehet kizárólag a betűstílusra és méretre támaszkodni a címsor szintjének jelzésére. A futó címsor "belefut" egy bekezdés elejébe, és ponttal végződik. Ezekhez a címsorokhoz használhat valamilyen kombinációt a vastag, dőlt vagy színes betűtípusokból.
Listák
A listák hasznos eszközök a fontos pontok hangsúlyozására, a szöveg gyors átnézésének lehetővé tételére és a több fehér tér biztosítására. Az alábbiakban bemutatjuk a listákra vonatkozó néhány alapvető irányelvet. Részletesebb megbeszélésért lásd a fejezetet a listák.
- Használj számozott listákat az olyan elemekhez, amelyek kötelező sorrendben vannak, vagy amelyekre szám alapján kell hivatkozni. Használj felsorolásbeli listákat az olyan elemekhez, amelyeknek nincs kötelező sorrendje.
- Használja a szövegszerkesztő szoftverek, HTML tagek és egyéb elérhető bekezdéstípusok szabványos számozott és felsorolásos listáit.
- Kérlek, írd át a listás elemek kifejezését! párhuzamos.
- Minden lista előtt egy bevezető mondatot kell használni; ne használj címeket a listák bevezetésére.
- Hacsak a szervezet stílusa nem írja elő másképp, a listaelemeket csak akkor tegyen ponttal, ha azok teljes mondatok vagy beágyazott függő mondatok vannak.
- Használj vagy kezdő nagybetűt, vagy kisbetűt a listaelemek első szavánál, de tedd ezt következetesen.
- A beágyazott listákhoz a második szintű listaelemeknél félkövér en dash-t használj a felsorolási szimbólumként; a második szintű számozott listaelemekhez kisbetűs betűket használj. Győződj meg arról, hogy a beágyazott elemek igazodjanak a szöveg vagy az előző szint.
- Kerüld a listák túlzott használatát, vagy a túl sok elemet tartalmazó listákat. Hetedik és tíz tétel általában a maximum diáknak tekinthető.
Értesítések
A figyelmeztetések olyan különösen formázott szövegrészek, amelyek figyelmeztetik az olvasókat különleges pontokra, kivételekre, potenciális problémákra vagy veszélyekre. Az alábbiakban néhány alapvető irányelvet mutatunk be a figyelmeztetésekkel kapcsolatban. A részletesebb megbeszéléshez lásd a fejezetet a értesítések.
- Használjon egy standard figyelmeztetési hierarchiát, amelyben a figyelmeztetések egyre hangsúlyosabbak és észlelhetőbbek, ahogy súlyosabbá válnak.
- Fontolja meg, hogy használja ezt a hierarchiát:
- veszélyjelzések olyan helyzetekre, amelyek súlyos sérülés vagy halálos kimenetel kockázatával járnak
- figyelmeztetések olyan helyzetekre, amelyek kisebb sérüléssel járnak
- óvintézkedések olyan helyzetekre, melyek berendezés vagy adatok károsodásával, vagy a folyamat sikerének fenyegetésével járnak
- megjegyzések a kivétel vagy hangsúlyozás pontjaira, amelyek nem érintik a korábbi helyzeteket.
- Bármilyen értesítő designt használsz, kerüld a hosszú szövegek írását teljesen vastag betűvel, dőlt betűvel, nagybetűkkel, vagy ezek kombinációjával.
- Ezen kívül, hogy elmondja az olvasóknak, mit tegyenek vagy mit ne tegyenek, magyarázza el, mi történik, ha figyelmen kívül hagyják a figyelmeztetést, milyen körülmények között érdemes figyelembe venni az állítást, és hogyan lehet helyreállni, ha az állítást figyelmen kívül hagyták.
- Tegye a figyelmeztetések szövegét tömörré, de ne a világos írás rovására. Kerülje a telegráf stílusú írást (mint például cikkek kihagyása). a, egy, a) a hirdetményekben.
- A számozott listákban igazítsa a megjegyzéseket a szöveg a listaelemre, amelyre vonatkoznak.
- A hirdetések elhelyezésének standard bölcsessége előtt Az a lépés, ahol a potenciális probléma fennáll, problémákat okozhat a formázásban. Ha lehetséges, figyelmeztetéseket, óvintézkedéseket vagy veszélyeket érdemes megemlíteni az egész eljárás elején.
Ábrák
A számok mindenféle illusztrációt, rajzot, sémaábrát, fényképet és így tovább jelentenek. Lásd grafika részletes megbeszéléshez. Közben itt van néhány fontos pont:
- A figura előtti szövegben kérjük, tegyen keresztutalást a figurára.
- Bár nem feltétlenül szükséges, hogy minden ábra aláírást (címet) tartalmazzon, ha mégis, akkor azt helyezze el alatt a figura.
- Például az utasításokban, amikor a képek szorosan kapcsolódnak az egyes lépésekhez, a képek címei nem fontosak, és nincs szükség rájuk.
Asztalok
A táblák olyan függőleges listák, amelyeket korábban tárgyaltunk, de struktúráltabbak és formálisabbak. A szövegében keressen ismétlődő párokat, hármasokat vagy négyeseket, amelyeket táblázatokba lehet formázni. Például a kifejezések és meghatározások sorozata klasszikus használata a táblázatoknak. A következőkben bemutatjuk a táblázatok standard irányelveit. Részletesebb megbeszélésért lásd a fejezetet a asztalok.
- Keresd a szövegben az ismétlődő elemek csoportjait, amelyeket táblázatokba formázhatsz.
- A táblázat előtti szövegben kérjük, hivatkozzon a táblázatra.
- Használj táblázatcímet, hacsak a táblázat tartalma nem teljesen nyilvánvaló, és a táblázat kevés elemet tartalmaz. Helyezd el a táblázat címet fent a táblázatot, vagy tedd a táblázat legfelső sorába.
- Használj oszlop- és sorcímeket (vagy mindkettőt) az oszlopok és sorok tartalmának meghatározására. Fontold meg, hogy valamilyen kiemelést alkalmazz az oszlop és sor címekhez.
- Igazítsa balra a szöveges oszlopokat (kivéve, ha egyszerű ábécé karakterekből állnak). Igazítsa balra a szöveges oszlopokat a fejlécükkel együtt.
- Jobbra igazítsa vagy tizedesvesszőhöz igazítsa a számadatokat, és középre helyezze a fejléc alatt.
- Helyezze el a szabványos mértékegységeket (ft, mm, gal.) a oszlop vagy sor fejlécében, nem pedig az oszlopban vagy sorban található minden egyes tételnél.
- Nyújtson egy rövid elemzést a táblázat fő tendenciájáról—amit szeretne, ha az olvasók észrevennének.
Kiemelés
A szoftverdokumentáció általában sok kiemelést használ. A kiemelés itt a félkövér, dőlt, eltérő betűtípusok, nagybetűk, idézőjelek és egyéb tipográfiai trükkökre utal, amelyeket a szöveg figyelemfelkeltésére használnak. Az alábbiakban néhány szabványos irányelvet mutatunk be a kiemeléshez. Részletesebb tárgyalásért lásd a fejezetet a kiemelés.
- Állítsa fel a kiemelés használatának tervét, és alkalmazza azt következetesen. Használjon kiemelést specifikus, funkcionális okokból. Kerülje a túlzott kiemelést; kerülje a bonyolult kiemelési rendszereket.
- Fontolja meg egy viszonylag szabványos kiemelési séma használatát:
- Egyszerű hangsúlyozásra használj dőlt betűs írást.
- **Használj** vastag betűt a **parancsok**, a **képernyőn lévő gombok** és a **menüopciók** esetében.
- Használj dőlt betűt az *változók* számára, amelyeket a felhasználóknak saját szavaikkal kell kitölteniük.
- Használjon alternatív betűtípust a képernyőn megjelenő szöveghez vagy a felhasználóknak beírásra szánt szöveghez.
- A képernyőn és mezőneveknél a képernyőn látható nagybetűs stílust használd, de más kiemelést ne alkalmazz.
- Használj kezdő nagybetűt a kulcsnevekhez, de más kiemelést ne alkalmazz.
- A fokozott hangsúly érdekében használja a megjegyzés formátumot.
Margók, Behúzás & Igazítás
Ahogy a fejezetcímekre vonatkozó szakaszban említve volt, szép megoldás, ha a szöveget egy-két hüvelyknyire behúzzuk, miközben a fejezetcímek a bal margón maradnak. Ez a stílus két dolgot ér el: kiemeli a fejezetcímeket, és rövidíti a normál szöveg sorhosszát.
Betűtípusok és Színek
Íme néhány javaslat a betűtípusokkal és a színekkel kapcsolatban:
- Használj csak egy alternatív betűtípust, legfeljebb kettőt. Például használhatsz Arial-t a címsorokhoz, Times New Roman-t a szöveghez, és Courier New-t a képernyőn megjelenő vagy a felhasználóknak megadandó szöveghez.
- Ha színt használsz, használd minimálisan. Például, ha fekete szöveged van fehér háttéren, választhatsz egy másik színt a címekhez. Ugyanezt a színt használhatod a képek és táblázatok címeinél, valamint a figyelmeztetések címkéinél (a tényleges "Megjegyzés," "Figyelmeztetés," "Óvatosság," és "Veszély" feliratok a figyelmeztetéseken).
- Kerüld az szokatlan háttér- és szöveg színkombinációkat. Például a lila vagy piros szöveg fekete háttéren borzalmasan nehezen olvasható. Maradj a fekete szövegnél fehér vagy szürke háttéren, hacsak nincs erős funkcionális ok más színkombinációra.
Értékelném a gondolataidat, reakcióidat, kritikáidat ezzel a fejezettel kapcsolatban: a válaszod.
