Help:Writing article introductions (Magyar)
Ez a cikk azért készült, hogy segítse az ArchWiki szerzőit és a szerkesztőit a hatékony cikkek létrehozásában, valamint bővítse az ArchWiki olvasónak az élményét.
Önnek nem szükséges tudnia, hogy miként kell egy wikioldalt szerkeszteni ahhoz, hogy kövesse ezt a cikket. Ez az oldal inkább egy általános stílusútmutató, semmint egy technikai jellegű szerkesztési cikk.
Cikk bevezetője
A cikk bevezetője (általában) az első dolog, amellyel az olvasók találkoznak, és célja, hogy bevezesse őket a témába.
Minden cikk első sora feltételezéssel indul. Ezek a feltételezések a legtöbb olvasóra ritkán igazak, és a cikk bevezetőjének célja, hogy kiszűrje azokat az olvasókat, akik megfelelnek a szerzők által tett feltételezéseknek. Valójában, Önnek mint szerkesztőnek/írónak nem szükséges bemutatnia az olvasók számára a cikk többi részét, de segíthet tisztázni néhány dolgot, amelyek egyébként még a teljes cikk (egymás utáni többszöri) elolvasása után is homályosak maradnának...
Például írhatott Ön egy cikket a rendszer egy bizonyos módon történő beállításával kapcsolatban. Azonban, Ön feltételezte, hogy az olvasóknak tiszta, és frissen telepített Arch Linux van az elsődleges adathordozón. Hogyan változna a módszere, amennyiben a kernel például testre szabott lenne? Vagy hogyan működne a 3. lépés, ha az X szoftvercsomag hiányozna?
Önnek gondolnia kell az Ön módszeréhez szükséges előfeltételekre, és ezeket az előfeltételeket be kell mutatnia, mielőtt elkezdené a cikket megírni. Ennek kettő fő előnye van:
- Lehetővé teszi az olvasók számára, hogy eldöntsék, vajon szeretnék-e elolvasni a cikket, mielőtt túl messzire jutnának benne.
- Lehetővé teszi Önnek, hogy túl sok felesleges kitérő nélkül írjon meg egy cikket.
A második pontnak óriási hatása van az olvasók teljesítményére, és valójában gördülékenyebbé teszi a cikkét.
Számos dolgot érdemes lehet beillesztenie a cikk bevezetőjébe, de íme néhány a fontosabbak közül, tetszőleges sorrendben:
- Szükséges előzetes tapasztalatok és ismeretek.
- Rendszerállapotok és beállítások.
- Hardverkomponensek birtoklása.
- Amit az olvasók nem fognak megtalálni a cikkben.
The text
We have already mentioned some things you might mention in an article introduction. We will now take a look at some of the problems in formulating an effective and useful article introduction.
Előzetes tapasztalatok és ismeretek
Amikor az előzetes tapasztalatokról beszélünk, Önnek figyelembe kell vennie, hogy a szónak kétféle jelentése van. Az egyik egy általánosabb jelentés. Valakit nevezhetünk kezdőnek vagy gurunak az adott személy általános tudása/tapasztalata/hírneve alapján. A másik jelentés egy konkrét, eseményben vagy tevékenységben való részvételből származó tapasztalat (és az ebből eredő tudás). Gyakorlati okokból célszerűbb az előzetes tapasztalatokat ez utóbbi értelemben megkövetelni. Az ArchWiki legtöbb cikke olyan témákról szól, amelyek konkrétak és adott kontextushoz kötöttek. Egy adott kontextusban egy kezdő is mutathat jártasságot, míg egy guru is mutathat érdektelenséget. Ha Ön konkrét előzetes tapasztalatokat követel meg, akkor az olvasóknak nagyobb esélyük lesz arra, hogy felmérjék, vajon képesek-e követni a cikk további részét.
Ön azt is megteheti, hogy az olvasók számára linkeket biztosít olyan információforrásokra, amelyek segítenek megszerezni a cikk megértéséhez szükséges ismereteket.
Rendszerállapotok és beállítás
Előfordulhat, hogy egyes rendszereken egy hiányzó szoftvercsomag miatt vagy egy eltérően beállított rendszerkomponens miatt, a cikkben leírtak nem felhasználhatóvá válnak. Ezért Önnek minden releváns rendszerbeállítást (például a vonatkozó rc.config paramétereket, szükséges szoftvercsomagokat stb.) minden esetben, amikor csak lehetséges, fel kell tárnia és meg kell határoznia.
Hardverkövetelmények
A hardverkövetelmények általában eléggé nyilvánvalóak. Ha például Ön az XYZ modem illesztőprogramjának a feltelepítéséről ír, senki sem gondolná, hogy a ZYX modemet említi. Ugyanakkor bizonyos esetekben érdemes konkrét hardverkövetelményeket is megemlíteni. Például amikor az XYZ-123 illesztőprogramjának feltelepítéséről ír, figyelmeztetheti az olvasókat, hogy ugyanez nem biztos, hogy érvényes az XYZ-456 feltelepítésére.
Az is egy szép cikk-kiegészítés, amikor hozzáadja annak a hardvernek a fényképét, amelyről az Ön cikke szól.
Amit az olvasók nem fognak megtalálni valamit a cikkben
Előfordulhat, hogy a cikk címe kissé félrevezető. Ezért Önnek szükséges lehet figyelmeztetnie az olvasókat a cikk valós témájára, és esetleg linket biztosítani más cikkekre, amelyeket az olvasók esetleg majd keresni fognak.
Például egyes olvasók azt hihették, hogy ez a cikk arról szól hogy, miként lehet oldalakat wikiszöveggel megformázni. Ezért ezek az olvasók figyelmeztetve lettek, hogy ez nem az az oldal, amit kerestek, és meg lett adva a helyes oldalra mutató link.
Formázás
A cikk bevezetőjének formázása a szokásos ArchWiki szokásokat követi. Ugyanakkor vannak olyan részletek, amelyek külön figyelmet érdemelnek.
A követelmények felsorolásakor Ön kettő megközelítést alkalmazhat. Az egyik megközelítés, hogy részletesen, de egyszerű nyelvezetet használva elmagyarázza a követelményeket és az egyéb bevezető megjegyzéseket (mindezt az Ön nyelvstílusában a bevezetőben). A másik megközelítés, hogy egy jól szervezett listában sorolja fel a követelményeket.