Csinálni! Közzé az online dokumentáció a projekt honlapján
A formátum az online dokumentáció
A legtöbb modern HAT-programok, mint Dr.Explain. képes létrehozni dokumentumok különböző formátumokban (pl WebHelp és PDF) egyetlen forráskódú projekt, minden további erőfeszítést az Ön részéről.
Egy másik fontos pont, hogy meg kell említeni a keretek használata. Sok évvel ezelőtt, amikor a dinamikus tartalom technológia (AJAX, HTML5, stb) volt új keletű, keretek tűnt egy jó módja az osztódó a dolgozó a böngésző ablak funkcionális területek - a cím, a tartalomjegyzék, a tartalom terület, stb Azonban most használják őket nem sok értelme van. Ők születtek inkább problémát, mint az általuk nyújtott előnyöket. A problémák között lehet azonosítani, mint - egy bonyolult navigációs és használhatóságát, a kényelmetlenséget, használati mobilböngészőkben, esetleges problémák kereső optimalizálás (SEO). Szinte az összes modern szoftver létrehozása dokumentumok WebHelp képes létrehozni anélkül, hogy a keretek használata nélkül feláldozná a dokumentáció.
Mozgás a dokumentáció
Ezért fontos, hogy megmutassa egy ilyen „csökkenés” a felhasználó, mely részében van, ahol ez a rész a teljes szerkezetét a projekt, mik a kapcsolódó téma, hogy lehet látni tovább, és általában véve minden olyan projekt dokumentáció ő valójában szól. Mindezek a problémák könnyen megoldható szervezésével jó navigációs dokumentációt.
Abstract screenshotok épülnek Dr.Explain programot eszközöket
tartalomjegyzék
dokumentáció tartalma legyen minden oldalon elérhető belőle. Tartalom azonnal mutatja a dokumentum struktúráját, a jelenlegi helyzetben a részt, és ami a legfontosabb, lehetővé teszi, hogy azonnal ugrik más szakaszokra. Ne engedje, hogy olyan helyzetben, amikor a tartalomjegyzék készül külön a gyökér oldalnyi dokumentációt. Ebben az esetben a felhasználónak kell folyamatosan megy vissza a gyökér tartalomjegyzéket, hogy majd lépni a másik oldalán. Ez kényelmetlen. Tipikusan az ilyen szerkezeti hiba létrehozott rekordok wiki-platformokon.
„Morzsa” (zsemlemorzsa)
„Morzsa” listájának megjelenítéséhez szülő partíció ehhez az oldalhoz. Ezek segítségével, akkor gyorsan kitalálni, mi több, a globális témák közé adott témában, és kattintson hozzáférés az egyiket.
lineáris navigáció
Linkek a következő és az előző oldalakon könnyen szekvenciális olvasási dokumentációt, különösen ha a tartalom nagyon nagy. Lineáris navigációs takarít meg a felhasználónak, hogy nézzen körül a fa alatt az aktuális témát, majd próbálja meg kitalálni, hogy mi a következő téma.
Kapcsolódó fejezet, alfejezet
Listája kapcsolódó témákról ( „Lásd még”), és egy lista az alfejezetek aktuális témák is elhelyezhető a az oldal alján. Ez a „kiválasztás” segíti a felhasználót, hogy gyorsan megtalálja több információt a kérdésekre anélkül, hogy keressen.
Branding és integráció a projekt területen
Könnyű használat
Szerencsére, a szakmai programot a fejlesztési dokumentációt, mint például Dr.Explain. tudja, hogyan kell létrehozni online súgó teljesen reagáló design, amely egyszerre támogatja a hagyományos és mobil elrendezését. Az ilyen dokumentáció kényelmesen használható mind az asztali számítógépen és mobil eszközökön.
Kölcsönhatás a felhasználók
Amellett, hogy a fő cél -, hogy segítsen a felhasználóknak dolgozni a termékről - dokumentáció is szolgálhat, mint egy marketing eszköz, és a kommunikáció eszközét a felhasználókkal.
Search Engine Optimization (SEO)
Figyelembe véve a marketing funkció az online dokumentáció, azaz használja, hogy vonzza az új felhasználók és elősegíti a termék a piacon, meg kell, hogy vesse fel a SEO (Search Engine Optimization).
On-line dokumentáció - egy hatalmas tömb információ, amely leírja a megoldást egy bizonyos osztály problémái vannak a termék. Emberek, akik az interneten keresnek megoldást ezekre a problémákra, de még nem ismerik a projekt - a potenciális felhasználók számára. Miután elolvasta a dokumentációban, hogyan ezek a problémák megoldhatók a készülékkel funkciókat, akkor valószínűleg szeretné kihasználni azt. Az egyetlen módja annak, hogy ezek az emberek -, hogy megbizonyosodjon arról, hogy a keresők - Google, Yandex, Bing, stb - kiadott, amilyen gyakran csak lehetséges, és közelebb a lap tetején linket az online súgó kapcsolódó kifejezésekkel leírása felhasználói problémák. Például a „hogyan kell optimalizálni PNG-kép paletta veszteség nélkül a minőség.”
Technikai részletek kereső optimalizálás dokumentációt kell szánnia egy külön cikkben. Már a kezdet kezdetén akkor megáll az alapelveket megfelelő információk bemutatása.
Jó szerkezetű az információt. Szét tartalom a teljes szemantikai szakaszok és témák, amelyek leírják a megoldást a konkrét problémákat. Nem teszik a hosszú, leíró túl sokat egyszerre. Információk minden oldalon legyen egyértelmű és lényegre törő.
Belül az oldalt is van egy világos szerkezetű. Használjon informatív fejezetei különböző szinteken, számozott listák és felsorolások. Próbáld meg használni az összefoglalók társított kulcsszavak leírását a probléma kiküszöbölése. Ne légy lusta, hogy teljesen aláírja a képek, táblázatok, grafikonok.
Perelinkovyvayte dokumentációs oldalán. Tedd a szöveg részben linkek más részei a dokumentáció, a hivatkozások a szövegben, használja a legfontosabb kifejezéseket (például „Kép átméretezése”), és nem a szavak dummy (például „kattintson ide” vagy „itt”).
Készítsen minden egyes téma egy külön fájlban a kulcsszavakat a fájl nevét. Minden téma az online segítség kell egy egyedi fájlnevet, és ennek eredményeként, és az egyedi URL-t, úgy, hogy a kereső is hivatkoznak rá. Ha növelni szeretné az oldal rangsor a keresési eredmények között, hogy ez egy értelmes nevet. Például, "csökkenti-kép-méret-by-korlátozó-colors.html" előnyösebb nevet, mint "page_34-838-b.htm". By the way, Dr.Explain program automatikusan hozza létre a fájlneveket neve alapján. Ez kényelmes.
elhelyezkedés
Helyezzük a súgó fájlt egy külön könyvtárba a termék honlapján. A felhasználók a könnyebb lesz elérni a dokumentációt, és könnyebb lesz fenntartani és frissíti az online súgó fájlok nem keverhető más részei a honlapon fájlokat.
elérhetőség
Ez a kérdés könnyen eltávolítható. Elég a linkeket a dokumentációt a főmenüben a helyszínen, valamint a támogatási oldalt és írja le a funkcionalitást a projekt.
Ne engedje, hogy olyan helyzetben, amikor a felhasználó nem találja a dokumentációt a saját és egyetlen esélye, hogy a hozzáférést meg -, hogy azt kérje közvetlenül a technikai támogatás.
Kövesse ezeket az elveket, és akkor viszont az online dokumentáció egy egyszerű, unalmas szövegeket egy erőteljes eszköz támogatja, a felhasználókkal való kommunikáció, és támogassák a projekt a piacon. A következő alapelveket egy pillanat alatt. Speciális programok létrehozására felhasználói dokumentációt, mint például Dr.Explain. dönt az Ön számára a legtöbb technikai kérdések, és lehetővé teszi, hogy összpontosítson, ami a legfontosabb - a felhasználókra és a projekt.
LETÖLTÉS
INGYENES
45Mb (ZIP), Windows Vista, 7, 8, 10 - 64 Bit
