Čo je príručka alebo referenčná príručka, ktorá používateľom poskytuje naratívny a grafický popis programu s názvom?

To znie, akoby ste popisovali dokumentáciu .

Tu je zrútenie toho, prečo:

* naratívny popis: Dokumentácia používa prirodzený jazyk na vysvetlenie, čo program robí, ako funguje, a jeho zamýšľané prípady použitia. Myslite na to ako na „príbeh“ softvéru.

* Grafický popis: Na ďalšie objasnenie dokumentácie často zahŕňa vizuály ako:

* Screenshots: Zobrazuje rozhranie programu a ako ho navigovať.

* diagramy: Ilustrujúce vzťahy medzi rôznymi časťami programu alebo procesmi.

* Vývojové diagramy: Znázornenie logických krokov procesu v rámci programu.

* Sprievodca a referencia: Dobrá dokumentácia slúži ako sprievodca (učia používateľov, ako robiť veci), ako aj ako referencia (poskytujúce rýchle odpovede na konkrétne otázky).

Rôzne formy dokumentácie

Dokumentácia môže mať veľa foriem v závislosti od zložitosti programu a cieľového publika:

* Používateľské príručky: Zamerané na koncových používateľov so zameraním na efektívne používanie funkcií programu.

* API Dokumentácia: Pre vývojárov, ktorí chcú integrovať funkčnosť programu do iných aplikácií.

* Technická dokumentácia: Zameraný na vývojárov pracujúcich na samotnom programe, ktorý sa týka jeho architektúry, kódovej základne a interných diel.

* Online pomoc: Integrovaný do softvéru a ponúka kontextovú pomoc v rozhraní programu.

* Výuky: Postupné sprievodcovia, ktorí prechádzajú používateľmi konkrétnymi úlohami alebo procesmi.

Dajte mi vedieť, či by ste chceli, aby som rozpracoval niektorý z týchto typov dokumentácie!

• Predchádzajúca strana: Aký aspekt vizuálnej prezentácie je rovnako dôležité médiá na umiestnenie? 
• Ďalšia strana: Čo je katalóg prezentácie Oracle BI?