Wiki motorok kiadása felhasználói dokumentáció

tézisek volt röviden a következő:

• A legkényelmesebb formája felhasználói dokumentáció - online dokumentáció;
• Az ilyen dokumentáció kényelmes terjeszteni, hozzáférés szabályozására, fenntartása és fejlesztése, hogy a felhasználók visszajelzései alapján;
• Sok olyan funkciók és eszközök forgalomba dokumentumokat az interneten, és mindenki kiválaszthatja az Ön ízlése és lehetőségei;
• A legtöbb hagyományos eszköze - platform wiki (wiki-motor), amelyek szeretnék mondani, ebben a cikkben.

A webinar, és miután kaptam kérdéseket, amelyek a motor közül lehet választani, és mit kell vele csinálni. Bevallom, abban az időben nem voltam kész javasolni valami konkrét, a választás nagyon nagy, és 1C-Együtt hasonló módon terjeszteni felhasználói dokumentáció nem gyakorolják a projektekben.

Tanulmányozása után több wiki-motorok jelenleg a figyelmét egy áttekintést DokuWikiben - egyszerű és erős motor, amelyet kifejezetten online dokumentációt.

DokuWikiben - ingyenes szoftver, melyet GPLv2 licenc bármely platformon fut, amelyen akkor képes lesz arra, hogy a PHP-t. A megkülönböztető jellemzője ennek a gépnek az, hogy amellett, hogy a PHP dolgozni nem volt szüksége semmilyen MySQL vagy PostgreSQL, azaz Működni fog gyakorlatilag bármilyen nagyon olcsó megosztott hosting.

További erősen függ, hogy hol és hogyan fognak elhelyezni a helyszínen dokumentációt. Próbáltam csinálni egy al-domain saját helyén egy virtuális szerver, ez nagyon egyszerű. A hosting központ létrehozása a web-domain, ne felejtsük el, rámutatni, hogy szükségünk támogatja a PHP. Hosting létrehoz egy üres könyvtárat az új helyén, dob át a panelt ZIP fájl a motorral, és adja a parancsot, hogy csomagolja ki. Ez az egész berendezést, menj a telepítést.

Nyissa meg az oldalt kezdeti beállítás:

Először is váltani közérthető nyelven, közvetlenül a tetején van egy választási listát Válasszon nyelvet, és kattintson a Frissítés gombra.

Bal azonosítja a fő paraméterei a motor DokuWikiben:

Push to menteni, törölni a install.php fájlt a host könyvtárban. Mindenképpen olvassa el a biztonsági tippek a fejlesztők és cselekszik.

A kezdeti telepítés befejeződött. Most már készen áll a kreatív folyamat, de ha nincs meg a tapasztalata az írás a wiki, egyértelművé kell tenni, számos kulcsfontosságú pontokat.

A következő szöveg színes matricák, így a fő gondolatok és fontos pontokat -, hogy ez egy jó stílus a Wiki. Címkét egészül .

Belül az összes cikk hasonló a szokásos felépítése a hagyományos dokumentum létrehozása a Word. Használja a H1 fejrésze Az 1. szinten annak érdekében, hogy a nevét, a cikk, H2, H3 és továbbra is olyan a szerkezete a cikket. Amikor a cikk több, mint 3 címei DokuWikiben automatikusan létrehoz egy tartalomjegyzéket rá.

DokuWikiben szerkezete hasonló a fa könyvtárakat és fájlokat. A teljes tartalmát dokumentáció úgynevezett „Index”, és költsége automatikusan. Gondold át a szerkezet előtt előzetesen van kitöltve.

Töltsük meg a wiki dokumentációt, persze, jobb, ha nem nyilvános, vagy bontsa ki a helyi hálózaton, vagy korlátozni a hozzáférést. A DokuWiki egyszerű és hatékony beléptető rendszert. Készítsen két biztonsági csoport: @editors - teszi hozzá a dolgozók a dokumentációban engedélyeket állíthat létrehozni és feltölteni a fájlokat és @users (ez alapértelmezés szerint létrejön) - benne adjunk a felhasználók, meg az olvasási engedélyeket, vagy nyitott olvasási hozzáférés minden @ALL.

És ha kell konvertálni PDF egy könyvben, hogy erre a célra van egy másik hasznos bővítmény BookCreator. A telepítés után ez szükséges ahhoz, hogy egy külön cikket oldal, ahol a könyveket kell építeni. Mutatva neki egyetlen tag

Összefoglalni. DokuWikiben - egyszerű és elég erős motort, hogy on-line dokumentációt konfigurációk 1C: Enterprise.

Az előnyök közé tartozik:

Között a hiányosságokat meg kell jegyezni: