Scriptbasic dokument ci metodol gia
This presentation is the property of its rightful owner.
Sponsored Links
1 / 26

ScriptBasic Dokumentáció metodológia PowerPoint PPT Presentation


  • 64 Views
  • Uploaded on
  • Presentation posted in: General

ScriptBasic Dokumentáció metodológia. Peter Verh á s 2002 április 23. Tartalom. Dokumentációk általában Feladatok, ki mikor miért készíti Egy konkrét példa forrás-dokumentáció módszerre. Miért kell a dokumentáció. A dokumentáció nem WOM A dokumentációt emberek olvassák Információ

Download Presentation

ScriptBasic Dokumentáció metodológia

An Image/Link below is provided (as is) to download presentation

Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author.While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server.


- - - - - - - - - - - - - - - - - - - - - - - - - - E N D - - - - - - - - - - - - - - - - - - - - - - - - - -

Presentation Transcript


Scriptbasic dokument ci metodol gia

ScriptBasic Dokumentáció metodológia

Peter Verhás

2002 április 23.


Tartalom

Tartalom

  • Dokumentációk általában

    • Feladatok, ki mikor miért készíti

  • Egy konkrét példa forrás-dokumentáció módszerre


Mi rt kell a dokument ci

Miért kell a dokumentáció

  • A dokumentáció nem WOM

  • A dokumentációt emberek olvassák

  • Információ

  • Szerződés melléklet, jogi kötés


Dokument ci k fajt ja a projekt sor n

Dokumentációk fajtája a projekt során

  • Tervezési dokumentációk

    • Funkcionális kívánalmakFUNRQ

    • Funkcionális specifikációFUNSP

    • Rendszer tervSYSSP

  • Fejlesztői dokumentációk

    • Architektúra leírásARCHD

    • Forrás kód dokumentációSOURD

    • Tesztelési dokumentációTESTD

  • Felhasználói dokumentáció

    • Installációs útmutatóINSTD

    • Rendszer karbantartási útmutatóMAIND

    • Felhasználói dokumentációUSERG


Funkcion lis k v nalmak

Funkcionális kívánalmak

  • Megrendelő írja

  • Minden álma benne van

  • Nem feltétlenül megvalósítható

  • Nem precíz

  • Üzleti kívánalmakat fogalmaznak meg benne

  • Tiszta képet ad a projektről, hogy miért is kell, mik az üzleti feltételek


Funkcion lis specifik ci

Funkcionális specifikáció

  • A kívánalmak alapján

  • Kölcsönösen elfogadott

  • Precízen megfogalmazott

  • Nem túlspecifikált

  • Általában ez a szerződés melléklete

  • Definiálja, hogy MIT fejlesztünk


Rendszer terv

Rendszer terv

  • Részletesen definiálja a HOGYAN-t

  • A fejlesztés során változhat

    • verzió kezelési kérdések

  • Ez alapján dolgoznak a fejlesztők


Architekt ra le r s

Architektúra leírás

  • Általánosan leírja az architektúrát, hogy utána a projektbe bekapcsolódó fejlesztő el tudjon igazodni a forráskód dokumentációban

  • Gépek, adatbázisok, táblák, szoftver komponensek, kapcsolódások


Forr s k d dokument ci

Forrás kód dokumentáció

  • Részben a forráskódban (megjegyzések, doc-string), részben maga a kód

  • Kódolási konvenciók


Tesztel si dokument ci

Tesztelési dokumentáció

  • Belső vagy külső (termék átadás-átvétel) definíció

  • Tesztelési eljárások definíciója

  • Tesztek leírása, tesztelési eredmények


Install ci s tmutat

Installációs útmutató

  • Fejlesztő készíti arról, hogy hogyan kell a rendszert az elkészített csomagból az éles rendszeren installálni

  • Dokumentáció tesztelése

    • Dok. Teszt. Dokumentáció


Rendszer karbantart si tmutat

Rendszer karbantartási útmutató

  • Fejlesztő készíti arról, hogy hogyan kell az installált rendszert kezelni

  • Adatmentése, visszaállítás

  • Archiválás

  • Teljesítmény mérés, skálázás, extrapoláció/trend analízis

  • Hibakezelés, riasztások

  • Naplózások


Felhaszn l i dokument ci

Felhasználói dokumentáció

  • NEM a fejlesztő készíti, külön szakma


Ki k sz ti a dokument ci t

Ki készíti a dokumentációt

  • Tervezési dokumentációk

    • Funkcionális kívánalmakügyfél

    • Funkcionális specifikációügyfél/fejlesztő

    • Rendszer tervfejlesztő (ügyfél látja)

  • Fejlesztői dokumentációk

    • Architektúra leírásfejlesztő

    • Forrás kód dokumentációfejlesztő

    • Tesztelési dokumentációtesztelő

  • Felhasználói dokumentáció

    • Installációs útmutatófejlesztő/dokumentátor

    • Rendszer karbantartásifejlesztő/dokumentátor útmutató

    • Felhasználói dokumentációdokumentátor


Mikor k sz l a dokument ci

Mikor készül a dokumentáció

Kódolás kezdete

Szerződés kötés

TESTD

SYSSP

USERG

SOURD

IDŐ

FUNRQ

FUNSP

ARCHD

INSTD

MAIND


Forr s dokument ci metodol gia a scriptbasic projektben

Forrás dokumentáció metodológia a ScriptBasic projektben

  • Alap formátum TEXI (GNU standard TeX macro csomag), jamal makrókkal

  • Konvertálható

    • PS, PDF minden nyomtatható formátum TeX-hel

    • HTML (egy fájl, fejezetenként)

    • CHM (compiled HTML)

    • RTF

    • INFO dokumentáció

    • Bármire konvertálható


Praktikusan mi a texi 1 2

Praktikusan: mi a TEXI 1/2

TEXI fejléc

\input texinfo @c -*-texinfo-*-

@c %**start of header

@setfilename devguide

@settitle ScriptBasic Users Guide

@setchapternewpage odd

@c %**end of header


Praktikusan mi a texi 2 2

Praktikusan: mi a TEXI 2/2

  • @chapter @section @sub...subsection

  • @code{}, @var{}, @option{}, @file{}, @b{}, @i{}

  • @itemize/ @item / @end itemize

  • @example / @end example


Praktikusan mi a jamal

Praktikusan: Mi a jamal

[email protected] MAC/X/Y/Z=Macro text}

{#use esd}

http://peter.verhas.com/progs/perl/jamal

xxx.jam

jamal.pl

xxx

esd.pm

esd.pm

esd.pm

esd.pm

esd.pm

esd.pm

*Embedded Source Documentation

Vagy más csomag


Texi gener l s jamal forr sb l

TEXI generálás jamal forrásból

perl jamal.pl devguide.texi.jam

devguide.texi.jam

jamal.pl

basext.c

builder.c

buildnum.c

cftc.c

cftd.c

command.c

confpile.c

conftree.c

dynlolib.c

epreproc.c

errcodes.c

execute.c

expression.c

filesys.c

getopt.c

hndlptr.c

hookers.c

httpd.c

ipreproc.c

lexer.c

linkedmodules.c

lmt_cio.c

lmt_httpd.c

lmt_none.c

lmt_wx.c

logger.c

lsp.c

match.c

matchc.c

memory.c

modumana.c

myalloc.c

mygmtime.c

mynotimp.c

notimp.c

options.c

prepext.c

reader.c

report.c

scriba.c

sym.c

syntax.c

testalloc.c

testconf.c

thread.c

uniqfnam.c

esd.pm

devguide.texi


Pdf html rtf texi b l

devguide_1.1.html

devguide_1.1.thtml

PDF, HTML, RTF... TEXI-ből

devguide.texi

t2h.pl

devguide.html

devguide.rtf

devguide_toc.thtml

devguide_toc.html

tex.exe

hhc.exe

devguide.pdf

devguide.ps

...

devguide.chm


Esd csomag haszn lata

esd csomag használata

{#sep/[[[/]]]}

[[[#use esd]]]

[[[#esd::command 0 s{\@\@}{SAVEALLDOUBLESOBAKA}g]]]

[[[#esd::command 0a s{\@}{\@\@}g]]]

[[[#esd::command 0b s{\{}{\@\{}g]]]

[[[#esd::command 0c s{\}}{\@\}}g]]]

[[[#esd::command 0d s{\$}{\@\$}g]]]

[[[#esd::command 1 s{\/\*FUNCTION\*\/}{\@example}]]]

[[[#esd::command 2 s{\/\*noverbatim}{\@end example}]]]

...

[[[@define SourceFile/FILE_NAME=[[[#esd::include ../../FILE_NAME /*POD CUT*/]]] ]]]


F ggv ny dokument l s p lda 1 2

Függvény dokumentálás (példa) 1/2

/*POD

=H log_state()

This function safely returns the actual state of the log. This can be:

=itemize

=item T<LOGSTATE_NORMAL> the log is normal state accepting log items

=item T<LOGSTATE_SHUTTING> the log is currently performing shut down, it does not accept any log item

=item T<LOGSTATE_DEAD> the log is shut down all files are closed

=item T<LOGSTATE_SYNCHRONOUS> the log is synchronous accepting log items

=noitemize

/*FUNCTION*/

int log_state(ptLogger pLOG

){

/*noverbatim

CUT*/

Miért =item és nem @item,

Miért =H és nem @section

Miért T<> és nem @code{}

...


F ggv ny dokument l s p lda 2 2

Függvény dokumentálás (példa) 2/2

Itt kezdi a szöveg beemelését

/*POD

=H log_state()

This function safely returns the actual state of the log. This can be:

=itemize

=item T<LOGSTATE_NORMAL> the log is normal state accepting log items

=item T<LOGSTATE_SHUTTING> the log is currently performing shut down, it does not accept any log item

=item T<LOGSTATE_DEAD> the log is shut down all files are closed

=item T<LOGSTATE_SYNCHRONOUS> the log is synchronous accepting log items

=noitemize

/*FUNCTION*/

int log_state(ptLogger pLOG

){

/*noverbatim

CUT*/

@section

@itemize

@item

@code{LOGSTATE_DEAD}

@end itemize

@end example

@example

Itt fejezi be a szöveg beemelését


N h ny m s forr sdokument l si lehet s g

Néhány más forrásdokumentálási lehetőség

  • Java -> JavaDoc

  • Python -> docstring (LaTeX)

  • Doxigen

  • esd2html.pl (SB korábbi eszköze)


K sz n m a figyelmet

Köszönöm a figyelmet


  • Login