technische doku schreiben ... wie?

Einklappen
X
 
  • Filter
  • Zeit
  • Anzeigen
Alles löschen
neue Beiträge

  • technische doku schreiben ... wie?

    hoi!

    ich soll zu einer web-basierenden software eine technische doku verfassen. ich weiss allerdings nicht ganz, wie sowas aussieht. es soll keine anleitung / manual sein. die gibbet schon. es soll mehr dargestellt werden, wie das ding funkt. natürlich so, dass es keiner "nachmacht". wer kann mir da mal ein beispiel geben?
    h.a.n.d.
    Schmalle

    http://impressed.by
    http://blog.schmalenberger.it



    Wichtige Anmerkung: Ich habe keine Probleme mit Alkohol ...
    ... nur ohne :-)

  • #2
    willst du ein script oder eine software beschreiben? oder eher ein system?

    wie dem auch sei. hier mal eine script/software-lösung. ist recht einfach gehalten. wenn du das aber so machst, bekommst du alles unter was du haben willst. erweiterung nicht ausgeschlossen..

    inhalt
    (ist klar oder?)

    einleitung
    kurze beschreibung und überblick über das ganze (1-2 seiten reichen völlig aus)

    kapitel 1 - anwendung
    was kann man damit machen, wie muss man z.b. die class ansprechen.

    kapitel 2 - code
    dein ganzes script hier erklärt. und zwar in unterkapiteln. eines pro funktion.

    anhang
    - code
    - aufrufendes programm
    - sonstiges
    INFO: Erst suchen, dann posten![color=red] | [/color]MANUAL(s): PHP | MySQL | HTML/JS/CSS[color=red] | [/color]NICE: GNOME Do | TESTS: Gästebuch[color=red] | [/color]IM: Jabber.org |


    Kommentar


    • #3
      @haxe, vielen dank. dieser aufbau gefällt mir. auf "anhang/code" werde ich allerdings verzichten

      es im übrigen noch immer um "verwaltungs-programm-projekt"
      h.a.n.d.
      Schmalle

      http://impressed.by
      http://blog.schmalenberger.it



      Wichtige Anmerkung: Ich habe keine Probleme mit Alkohol ...
      ... nur ohne :-)

      Kommentar


      • #4
        wenn du im quelltext schön mit kommentaren gearbeitet hast, hilft dir eventuell www.phpdoc.org weiter

        ich denke mal, was du in deinen quelltext geschrieben hast an kommentaren, reicht um die funktionalität jeder funktion zu beschreiben, ohne zu tief ins detail zu gehen
        Ich denke, also bin ich. - Einige sind trotzdem...

        Kommentar


        • #5
          ich hasse die seiten, auf denen vor lauter links die seite nimmer findet. aber trotzdem danke, werde es mir mal in ruhe ansehen ..
          h.a.n.d.
          Schmalle

          http://impressed.by
          http://blog.schmalenberger.it



          Wichtige Anmerkung: Ich habe keine Probleme mit Alkohol ...
          ... nur ohne :-)

          Kommentar

          Lädt...
          X