Standard za pisanje dokumentacije

Standard za pisanje dokumentacije

Standard za pisanje dokumentacije

U okviru ovog dela uputstva nalazi se standard za pisanje dokumentacije odnosno pravila koja se moraju ispoštovati kako bi se zadržao stil pisanja u okviru celokupne dokumentacije. 

Naime, pisanje dokumentacije sastoji se iz opisa modula panela i funkcionalnosti samih modula. Opisivanje modula se zasniva na nekoliko jednostavnih pravila i to:

  1. Svaki modul predstavlja jednu kategoriju koja ima nadređenu kategoriju Dokumentacija ukoliko kreirana kategorija predstavlja ceo modul ili nadređenu kategoriju ukoliko kreirana kategorija predstavlja podmodul
  2. Pri kreiranju kategorija koristi se šablon prikaza Category documentation
  3. Sadržaj uputstva unosi se u okviru polja za opis kategorije
  4. Opis nadređene kategorije (glavnog modula) sastoji se iz uvodnog objašnjenja svrhe modula, slike pristupa modulu kao i linkovima ka podmodulima glavnog modula. Ispravno kreiran opis nadređene kategorije dat je na slici:

        5.Svako opisivanje mora imati kratak rezime na početku koji predstavlja stavke koje će se opisivati u daljem tekstu kao što je prikazano na slici:

        6.Opisivanje kategorije se započinje iz opšteg uvida u sam modul kao što je prikazano na slici:

       7.U okviru uputstva je obavezno opisati sve funkcionalnosti u okviru modula. Ispravno opisane funkcionalnosti možete pogledati ovde.

       8.Svako objašnjenje je potrebno propratiti slikama