Motoare Wiki pentru publicarea documentației de utilizare

teze au fost pe scurt după cum urmează:

• Forma cea mai convenabilă de documentație de utilizare - documentația on-line;
• Această documentație este convenabil de a distribui, controla accesul, să mențină și să dezvolte, pentru a primi feedback de la utilizatori;
• Există mai multe caracteristici și instrumente pentru introducerea documentelor pe internet, și toată lumea poate alege în funcție de gustul și oportunitățile;
• Instrumentul cel mai tradițional - platformă wiki (wiki-motoare), din care vreau să-ți spun în acest articol.

Pe webinar, și după ce am primit întrebări pe care motorul de a alege și ce să facă cu ea. Recunosc, la acel moment nu am fost pregătit să recomande ceva, în special, alegerea este foarte mare, și 1C-Împreună mod similar de a distribui documentația de utilizare nu se practică în proiecte.

După ce a studiat mai multe wiki-motoare, prezent în atenția dumneavoastră o prezentare generală a DokuWiki - motor simplu și puternic, care a fost proiectat special pentru documentația on-line.

DokuWiki - software liber, distribuit sub licență GPLv2, ruleaza pe orice platforma pe care va fi capabil de a avea PHP. O trăsătură distinctivă a acestui motor este că, în plus față de PHP pentru a lucra el nu a avut nevoie de nici MySQL sau PostgreSQL, și anume Acesta va funcționa pe aproape orice hosting partajate foarte ieftine.

În continuare depinde foarte mult de unde și cum aveți de gând să plaseze un site cu documentație. Am încercat să o fac într-un sub-domeniu al site-ul lor pe un server virtual, este foarte simplu. În panoul de control de găzduire a crea un web-domeniu, nu uitați să subliniem faptul că avem nevoie de suport pentru PHP. Hosting creează un director gol pentru noul site, aruncă prin panoul de la ZIP-fișier cu motorul și să dea comanda de a despacheta. Asta întreaga instalație, du-te la configurarea.

Deschideți pagina configurarea inițială:

În primul rând a comuta la limbaj simplu, chiar la partea de sus există o listă de opțiuni Alegeți limba și faceți clic pe butonul Actualizare.

Stânga identifică principalii parametri ai unui motor DokuWiki:

Push pentru a salva, șterge fișierul install.php din directorul gazdă. Asigurați-vă că pentru a citi sfaturi de siguranță de la dezvoltatorii și de a face ei.

Configurarea inițială este finalizată. Acum suntem gata pentru a începe procesul de creație, dar dacă nu aveți experiența de a scrie wiki, ar trebui să clarifice o serie de puncte-cheie.

Utilizați autocolante de culoare de text, aducând în principalele idei și puncte importante - care este un stil bun în Wiki. Se introduce tag-ul autocolant .

În interiorul toate articolele similare cu structura obișnuită a unui document convențional pe care îl creați în Word. Utilizați H1 antet a nivelului 1, pentru a da numele articolului, H2, H3 și să continue pentru a crea structura articolului. În cazul în care articolul să fie mai mult de 3 titluri DokuWiki va crea automat un cuprins la ea.

Structura DokuWiki similar cu un arbore de directoare și fișiere. Conținutul total de documentare numit „Index“ și este cost automat. Gândiți-vă peste structura în avans, înainte de a fi umplut.

Completați documentația wiki, desigur, mai bine să nelistat sau extinde toate rețeaua locală, sau pentru a restricționa accesul. În sistemul de control al accesului simplu și puternic DokuWiki. Creați două grupuri de securitate: @editors - adaugă angajații care lucrează cu documentația, set de permisiuni pentru a crea și încărca fișiere și @users (este creat în mod implicit) - în ea adăugați utilizatori, setați permisiuni de citire, sau deschis pentru acces la citire toate @ALL.

Și dacă aveți nevoie pentru a converti PDF într-o carte, că, în acest scop, există o altă BookCreator plugin util. După instalarea este necesar să se facă o pagină specială de articol, în cazul în care cărțile urmează să fie construite. Arătând singură etichetă ei

Pentru a rezuma. DokuWiki - un motor destul de simplu și puternic pentru a crea configurații de documentare on-line pe 1C: Enterprise.

Avantajele includ:

Printre deficiențele trebuie remarcat: