Súgófájl készítése: 10 lépés (képekkel)

Tartalomjegyzék:

Súgófájl készítése: 10 lépés (képekkel)
Súgófájl készítése: 10 lépés (képekkel)

Videó: Súgófájl készítése: 10 lépés (képekkel)

Videó: Súgófájl készítése: 10 lépés (képekkel)
Videó: FineReader 14 Hogyan… : Szerkesszünk PDF dokumentumokat 2024, Március
Anonim

Bár sok számítógép -felhasználó gyakran figyelmen kívül hagyja, a súgófájlok kulcsfontosságú információkat tartalmaznak a hozzájuk társított szoftveralkalmazás használatáról. A "Súgó" gombra kattintva a felhasználó áttekintést kaphat a program jellemzőiről, a képernyő leírásáról, amelyet néz, valamint utasításokat arról, hogyan kell használni a programot egy adott feladat végrehajtásához, vagy elolvashatja a témával kapcsolatos gyakran ismételt kérdések listáját. program és a válaszaik. A súgófájl írásához szükség van a szoftveralkalmazásokkal való munkavégzés képességére, valamint arra, hogy a felhasználók számára érthető módon magyarázzák a dolgokat.

Lépések

Súgófájl létrehozása 1. lépés
Súgófájl létrehozása 1. lépés

1. lépés Szerezzen be egy másolatot a dokumentálni kívánt szoftverről

Ha lehetséges, szerezzen be egy másolatot a program írásos specifikációiról is, bár nem minden szoftverfejlesztő dolgozik velük. Bizonyos esetekben a programozó eltér a specifikációktól, a rövid fejlesztési idő vagy az adott szolgáltatás kódolásának hiánya miatt.

Súgófájl létrehozása 2. lépés
Súgófájl létrehozása 2. lépés

2. lépés. Szerezzen be egy súgószerző eszközt

Bár a súgófájl kézzel is létrehozható, gazdag szöveges formátumú (.rtf) fájl használatával, a legtöbb súgófájl-készítő egy szoftveralkalmazást használ a súgófájlok írásához, például a RoboHelp, a Help and Manual, a Doc-To -Help, MadCap Flare vagy HelpLogix. A legtöbb súgószerkesztő eszköz tartalmaz egy szövegszerkesztőt vagy egy szövegszerkesztő programmal, mint például a Microsoft Word, és olyan felhasználói felületet biztosít, amely lehetővé teszi a súgó szerzőjének, hogy lássa, hogyan fog kinézni a súgófájl, miközben írja, miközben a számítógép kulcsát írja. hogy a súgófájl működjön. Bizonyos súgószerkesztő eszközök grafikus szerkesztőket is tartalmaznak a súgófájlba beépítendő képernyőképek létrehozásához.

Számos súgófájl -formátum létezik: A leggyakoribb a HTML -súgó, amelyet a Windows rendszerben futó alkalmazások használnak. (Egy régebbi formátum, a WinHelp már nem támogatott.) Az Apple és a Unix is rendelkezik saját formátumokkal, csakúgy, mint a Sun Microsystems, a JavaHelp segítségével. A több operációs rendszer alatt történő futtatásra tervezett szoftveralkalmazások használhatnak platformok közötti súgórendszert, amely a felhasználó webböngészőjében fut. Bármelyik súgószerkesztő eszközt is használja, támogatnia kell azokat a súgóformátumokat, amelyekben súgófájlokat hoz létre

Súgófájl létrehozása 3. lépés
Súgófájl létrehozása 3. lépés

3. lépés. Hozza létre a súgó projektfájlt

A súgószerző eszköz létrehoz egy súgóprojektfájlt az Ön számára a megadott fájlnév és egyéb információk alapján. A fő projektfájl információkat tartalmaz a többi fájlról, például tartalomfájlt, indexfájlt, egy vagy több képfájlt és egyéb fájlokat.

  • A tartalomfájl tartalmazza a súgófájl szövegét, amely elmagyarázza, hogyan működik a dokumentált szoftver. A szöveget általában olyan témákra bontják, amelyek egy adott képernyőt, funkciót vagy eljárást fednek le.
  • Az indexfájl a súgófájl témáinak listája. Tartalomjegyzék létrehozására szolgál, amellyel a felhasználók kiválaszthatják a megtekinteni kívánt témát, valamint egy kereshető indexet a súgófájlban.
  • A képfájlok a programképernyők grafikus fájljai vagy azoknak a súgófájlban megjelenített részei, hogy a felhasználók jobban megértsék, mire utal a súgófájl szövege.
Súgófájl létrehozása 4. lépés
Súgófájl létrehozása 4. lépés

4. lépés: Állítsa be a súgóablak méretét

Hacsak nem azt írja, hogy a súgófájl megjelenik a felhasználó webböngészőjében, a súgófájl a saját ablakában jelenik meg. Segítségkészítő eszköze lehetővé teszi az ablak vízszintes és függőleges méreteinek olyan méretre állítását, amely lehetővé teszi a végfelhasználó számára, hogy anélkül olvassa el a súgófájlt, hogy az akadályozná az alkalmazást. A fő súgóablak gyakran háromablakos formátumú, a tartalomjegyzék a bal oldalon, a kiválasztott téma pedig a jobb oldalon.

A súgófájlokban a főablak mellett másodlagos ablakok is találhatók, amelyek részletesen leírják az adott funkciót, és automatikusan méreteznek a funkciók rövid leírását tartalmazó előugró ablakokat. A súgófájlok olyan beágyazott szöveget is tartalmazhatnak, amely csak akkor jelenik meg, ha a kiemelt szövegre vagy a gombra kattint

Súgófájl létrehozása 5. lépés
Súgófájl létrehozása 5. lépés

5. lépés. Írja be a súgótémákat

Ehhez át kell tekintenie a specifikációkat vagy magát a programot, hogy létrehozza azokat a témákat, amelyek dokumentálják a program képernyőit és funkcióit. Az egyes témák létrehozásakor a súgószerző eszköz hozzáadja azokat a súgófájl tartalomjegyzékéhez és indexéhez.

  • Bár menet közben elkészítheti a tartalomjegyzéket, segít, ha van valami tervezete annak megszervezésére. A tartalomjegyzéket a program képernyői, funkciói, használati módjai vagy ezek kombinációja köré rendezheti.
  • A témák írásakor vegye figyelembe a súgófájl egyéb olyan információit, amelyekhez a felhasználók gyorsan hozzáférni szeretnének. Ugrásokat vagy hiperhivatkozásokat hozhat létre a súgófájl szövegében, amelyek kapcsolódnak az ilyen információkat tartalmazó témákhoz.
Súgófájl létrehozása 6. lépés
Súgófájl létrehozása 6. lépés

6. lépés. Szükség esetén mellékeljen képernyőképeket

A program számos funkcióját a szöveg és a grafika kombinációjával lehet a legjobban megmagyarázni. Létrehozhat képernyőképeket a súgószerző eszközhöz mellékelt alkalmazással vagy egy külön alkalmazással, például a Microsoft Paint, a Paint Shop Pro vagy a SnagIt segítségével.

  • A szöveget és a képernyőképeket együtt kell elhelyezni egy témában, hogy a felhasználók indokolatlan görgetés nélkül láthassák a képernyőképet és az azt támogató szöveget. Sok esetben a program képernyőjének egy részét kell megjelenítenie a teljes képernyő helyett, vagy a képernyőképet kisebb méretben kell megjelenítenie, mint az eredeti. A képernyőkép -alkalmazásnak képesnek kell lennie a képernyőkép átméretezésére, elmosódás vagy részletvesztés nélkül.
  • Ha előre látja, hogy a program teszt- és végleges verziói között változás következik be a felhasználói felületen, akkor érdemes leállnia a képernyőképek létrehozásáról, amíg meg nem kapja a program végleges verzióját.
Súgófájl létrehozása 7. lépés
Súgófájl létrehozása 7. lépés

Lépés 7. Hozzon létre egy térképfájlt, ha szüksége van rá

Néhány program tartalmaz "Súgó" gombokat, amelyekkel a felhasználó rákattinthat és megjelenítheti a témát a súgófájlban, amely kifejezetten leírja a képernyő működését. A téma ilyen módon történő megjelenítését környezetfüggő segítségnek hívják, és térképfájlt kell létrehoznia ahhoz, hogy a programozó összekapcsolhassa a "Súgó" gombot a súgófájl adott témájával. A súgószerző eszköz létrehozhat egyet az Ön számára, vagy a programozó kódolhatja, és megadhatja a súgófájlba.

Súgófájl létrehozása 8. lépés
Súgófájl létrehozása 8. lépés

8. lépés. Fordítsa össze a súgófájlt

A fordítás létrehozza a tényleges súgófájlt, amelyet a program tartalmaz. A legtöbb súgóformátum esetében ez magában foglalja a súgófájl létrehozásakor létrehozott összes összetevőfájlt, bár egyes lefordítatlan súgóformátumok megkövetelik, hogy az egyes súgótémakör fájlokat is tartalmazzák a programban.

Súgófájl létrehozása 9. lépés
Súgófájl létrehozása 9. lépés

9. lépés: Tesztelje a súgófájlt

Miután összeállította a súgófájlt, tesztelnie kell, hogy megbizonyosodjon arról, hogy az összes hiperhivatkozás kapcsolódik -e a kívánt témákhoz, és az összes grafika megfelelően jelenik meg. A súgófájlt is tesztelni kell annak biztosítása érdekében, hogy a tartalom pontos, a felhasználóknak megfelelő és egységes formátumú legyen. Érdemes áttekinteni a súgófájlt, és kérni, hogy az alkalmazást tesztelő személyek is tekintsék át.

Nagyobb súgófájl -projekteknél a fordítás és tesztelés folyamatos folyamat. A végső verzió létrehozása előtt össze kell állítania a súgófájlt, és többször ellenőriznie kell a munkáját

Súgófájl létrehozása 10. lépés
Súgófájl létrehozása 10. lépés

10. lépés: Adja a súgófájlt a fejlesztőnek, hogy vegye be a programba

A projekt jellegétől és a súgó fájlformátumától függően előfordulhat, hogy több fájlt kell biztosítania a fejlesztőnek, beleértve a térképfájlt is, ha vannak környezetfüggő témák.

Ajánlott: