Tippek a jó stílushoz

Íme néhány tipp arra vonatkozóan, hogyan kell jó wikioldalt írni.



1. Szerkezetek


  • Kezdje az oldalt egy első szintű, értelmes címmel ellátott fejléccel.
  • Fészkelje be a fejlécszinteket a megfelelő sorrendben, a második szinten lévő szakaszokat a második szintű fejléccel kell kezdeni.
  • A szöveget bekezdésekre bontva hagyjon üres sort közöttük. Egy átlagos bekezdés ne legyen hosszabb 10-20 sornál.
  • Ha a szövege hosszabb néhány (3-5) bekezdésnél, fontolja meg a szöveg szakaszokra való felosztását második-ötödik szintű címsorok hozzáadásával.
  • Ha a szöveg 2-3 képernyőoldalnál hosszabb, az első címsor után helyezzen el egy rövid összefoglalót az oldal tartalmáról. Ha az oldal jelentősen hosszabb lesz, fontolja meg a több oldalra való felosztást.
  • Ha sok hivatkozásod van más wikioldalakra vagy külső forrásokra, adj hozzá egy külön részt további hivatkozásokkal (lásd alább).
  • Ha egy névtér legtöbb oldalának közös a szerkezete, adj hozzá egy névtérsablont, hogy minden új oldal ezzel a vázszerkezettel kezdődhessen.
  • Próbáljuk elkerülni a túlbonyolított névtérstruktúrákat. Próbáljunk rövid, könnyen megjegyezhető névtérneveket használni.

2. Szövegformázás


  • Hangsúlyozza ki az egyes szavakat vagy rövid szövegrészeket félkövér vagy dőlt betűkkel. Válassza ki az egyiket, és ragaszkodjon a választáshoz.
  • Válasszon egy stílust a képernyőn megjelenő kimenetek és a képernyőn megjelenő szöveg, például a gombok vagy menücímkék megjelenítésére, és használja következetesen. Jó ötlet lehet, ha a wikihez hozzáadsz egy oldalt a stíluskonvenciók magyarázatával.
  • Használjon rendezetlen listákat az egymástól független állításokhoz. Ha egy gondolatsort dolgoz ki, írjon folyamatos mondatsorban.
  • Lábjegyzeteket takarékosan és csak nagyon rövid kiegészítő megjegyzésekhez használjon. Ha egy adott témáról sokkal több mondanivalója van, tegye azt egy új wikioldalra. Ha más (külső) információforrásokra akarsz hivatkozni, használj inkább linkeket.
  • A táblázatok nagyban javíthatják a strukturált adatok olvashatóságát. Ha táblázatot illesztesz be, győződj meg róla, hogy értelmes cellafejlécekkel rendelkezik, és adj meg egy feliratot, amely világosan kifejezi a táblázat tartalmát (pl. "1.2. táblázat: A bolygók közötti átlagos távolságok").
  • A nagy táblázatok általában nagyon nehezen szerkeszthetők. Fontolja meg, hogy az adatait inkább egy egymásba ágyazott listában ábrázolja.

3. Nyelv


  • Írjon megfelelő mondatokat, és szükség esetén használjon cikkeket a főnevek helyett.
  • Minden mondatot kezdjen nagybetűvel, és fejezze be ponttal vagy más megfelelő írásjelekkel.
  • Próbáljon meg rövid, világos mondatokat írni anélkül, hogy túl sok mellékmondatot használna. Amikor úgy gondolod, hogy befejezted az oldaladat, olvasd el újra, és dolgozz át minden olyan mondatot, amelynek túl bonyolult a szerkezete.
  • Döntsd el, hogyan szólítsd meg az olvasóidat. Mivel a Wiki a dokumentáció írására irányul, gyakran kell majd utasítanod az olvasóidat, hogyan kell bizonyos dolgokat csinálni. Használhatod a felszólító formát ("Tedd ezt!"), a mi/mi formát ("Akkor mi/mi kattintsunk a...") vagy az én formát ("Én akkor hozzáadom a foo-t a bar-hoz, a... segítségével..."). Ne keverje ezeket a formákat.
  • Mentés előtt ellenőrizze az oldalát nyelvtani vagy helyesírási hibák szempontjából. Ha a szövegedben sok hiba van, az csökkenti az állításaid hitelességét, függetlenül attól, hogy mennyire jól átgondoltak.
  • Fejleszd ki a saját stílusodat. Ne kényszerítse magát arra, hogy olyan módon írjon, ami nem esik jól. Ez csak természetellenesen hangzana, és kellemetlen lenne olvasni.

4. Hivatkozások


  • Ha olyan kifejezéssel találkozol, ami bővebb magyarázatra szorul, adj hozzá egy új wiki oldalt a kifejezéshez, és linkeld be.
  • Ellenőrizd újra az oldaladat, mielőtt befejeznéd, és add hozzá a meglévő wikioldalakra mutató linkeket az oldalad központi fogalmaihoz.
  • Ne adj linket egy adott kifejezés minden egyes előfordulásához. Az oldalon az első/legszembetűnőbb előforduláshoz tegyél linket, és esetleg adj hozzá egy linket a hivatkozási részhez.
  • Adjon linkeket a képek, adatok és idézetek forrásaira.
  • Fontolja meg egy "Lásd még:" sor hozzáadását az oldal végén. Adj linkeket olyan wikioldalakra, amelyek szorosan kapcsolódnak az oldalad témájához ott.
  • Ha olyan külső forrásokra szeretnél utalni, amelyek további információkat tartalmaznak a témádról, vagy amelyeket az oldalad megírásakor használtál, akkor a végén adj hozzá egy "Hivatkozások" vagy "További információk" című részt, és add meg a hivatkozások vagy egyéb utalások (pl. ISBN-számok) listáját. Ha a főszövegben még nem tette meg, adja meg a hivatkozás célját.
  • Az interwiki rövidítések beállítása segíthet a közös forrásokra való hivatkozásban.

5. Képek és egyéb médiumok


  • "Egy kép többet mond ezer szónál." Még az is lehet, hogy többet jelent, mint amit mondani akartál. 1) Az emberek hajlamosak kevésbé megkérdőjelezni a képek hitelességét, mint a nyelvét. Egy rövid szöveges leírás jobb, mint egy pontatlan kép.
  • A táblázatokhoz hasonlóan a képekhez is mindig adjon feliratot, amely kifejti, hogy mit szeretne megmutatni a képpel.
  • Ha nem saját maga készítette a képet, adja meg a forrást (esetleg linkkel) és a szerzői jogokat.
  • Ne linkelj képeket külső oldalakról, kivéve, ha ez kifejezetten engedélyezett. Ez elsősorban szerzői jogi kérdés, de a sávszélesség ellopása is lehet, ha a külső képek gyorsítótárazása ki van kapcsolva.
  • Ha a kép nagyobb, mint egy képernyőoldal nagyjából egyharmada, használjon egy linket, amelyhez méretváltoztatási utasításokat ad egy miniatűr kép beillesztéséhez.

Read comments (0 comments)