Technikai írás forrásai

Ez az oldal további technikai írás forrásait foglalja össze.

Szerkesztői stílusiratok

A szerkesztői stílusiratok meghatározzák egy szerkesztői csoport kommunikációs irányelveit. Például az alábbi szabályok közül melyiket kellene a szervezetének elfogadnia a címszavakra vonatkozóan?

• A címszavakat mondatnégyzetben írja (minden címszónak csak az első szavát írja nagybetűvel)
• A címszavakat nagybetűvel írja (minden címszóban a legtöbb szót nagybetűvel írja)

Ne vesztegesse az idejét és energiáját az ilyen jellegű kérdésekről való vitatkozásra.Ehelyett egyszerűen kérje meg a szervezetét, hogy fogadjon el egy adott szerkesztési stílusirányelvet.Egy szerkesztési stílusirányelv válaszokat ad az írásbeli választásokkal kapcsolatos kérdésekre. Nem számít, hogy az egyik szerkesztési stílusirányzat a mondatbetűs írásmódot, a másik pedig a címbetűs írásmódot részesíti előnyben. Csak az számít, hogy az Ön szervezete egyetlen szerkesztési stílusjegyzéket fogadjon el.

Ah, de melyik szerkesztési stílusjegyzéket?Lehet, hogy Ön már ismeri az általános célú szerkesztési stílusjegyzékeket (például a Chicago Manual of Style vagy az University of Oxford StyleGuide).A mérnöki csapatnak azonban a műszaki írásra szakosodott szerkesztési stílusjegyzéket kellene használnia. Javasoljuk, hogy válasszon az alábbiak közül:

• A Google fejlesztői dokumentáció stílusútmutatója szerkesztési irányelveket nyújt mindazok számára, akik a Google-hez kapcsolódó projektek fejlesztői dokumentációját írják.
• A Microsoft írói stílusútmutatója irányelveket nyújt mindazok számára, akik műszaki dokumentációt írnak.

Ne írjon saját szerkesztési stílusútmutatót. Egy “házi” szerkesztési stílusútmutató létrehozása és karbantartása óriási erőforrásokat igényel és óriási konfliktusokat okoz. Ennek ellenére egyes szervezetek új terminológiát találnak ki, amely nem jelenik meg a meglévő szerkesztési útmutatóban. Ilyenkor a szervezet a következők valamelyikét teheti:

• Kérje meg egy szerkesztési stílusjegyzék karbantartóit, hogy adják hozzá az új kifejezéseket.
• Készítsen és tartsa fenn saját használati útmutatót vagy stíluslapot, amely kodifikálja a szervezet szakszókincsének helyesírását és szóhasználatát.

A nyílt forráskódú dokumentáció lehetőségei

.