UML uml.org

Hur man dokumenterar

Länkar till sidor som beskriver olika sätt att dokumentera ett webbprojekt:

comentum

En väääääääääldigt djupt ingående beskrivning om hur kodningen ska göras finns här:

w3

Dokumentation av webbapplikation

. 1 Planering : Definiera Webbapplikationen

syfte , mål och inriktning

( Framförd av klient / projektägare ) Denna första uppgift är en viktig del av processen. Det kräver att sammanställa mål Web Application projekt och ändamål .

Detta steg fastställer projektets innehåll och hjälper dig att fokusera på att fastställa och uppnå dina mål .

Projektplanen dokument kommer att ange Webbapplikationens utveckling och målen med ungefärliga tidslinjer .

2 . Forska och definiera publik Omfattning och säkerhetsdokument

Analysrapport

- Typ av målgrupp: åldrar och kön - Typ och grad av tillgång : intranät , Internet , applikation - Typ av publik för att planera säkerhetsnivån : Att skapa ett risk Statistisk dokument som grundar sig på användarnas egenskaper , zons bedrägerinivå, programmets industri säkerhetsöverträdelser , och historien om målgruppens säkerhetsöverträdelser - Kvantitativa statistik över publiken : planerad

3 . Specifikation av funktioner (kravspec)

( Framförd av klient / projektägare ) En Web Application Funktionalitet Specifikationer dokument är det viktigaste dokumentet i alla Web Application projekt . Detta dokument kommer att lista alla de funktioner och tekniska specifikationer som en webbapplikation kommer att kräva att åstadkomma. Tekniskt sett kan detta dokument bli överväldigande om man har att följa de funktionella specifikationerna regeln och detaljer ur varje typ av användares beteende på ett mycket stort projekt . Men det är värt att lägga fram de ansträngningar för att skapa detta dokument som bidrar till att förhindra eventuella framtida förvirring eller missförstånd av projektets egenskaper och funktioner , både projektägare och utvecklare . En typisk funktionell specifikation kommer att lista varje användares beteende , till exempel :

När en besökare klickar på " Lägg till i varukorgen " knappen från produktsidan sidan , läggs objektet till besökarens kundvagn, stänger Product Showcase sidan och användaren tas till kundvagn sida som visar den nya posten i vagn. Om du skapar en funktionell specifikation dokument är överväldigande för dig , rekommenderar jag att du börjar med att skapa en specifikation dokument eller Feature Sammanfattande dokument genom att antingen skapa prov skärmdumpar av webbprogramskärmareller skapa ett dokument som innehåller en sammanfattande lista över programmets funktioner , till exempel :

Produkt / Inventering Sammanfattning Showcase : visar en sammanställning av artiklar för försäljning , lager , artikelnummer namn , kort beskrivning , en foto , pris , och Lägg i varukorgen knappen . Produkt / Inventering En Artikelnummer Showcase : visar detalj av en inventering post : lager , artikelnummer namn , lång beskrivning , flera foton ( upp till 10 foton ) , pris , och Lägg i varukorgen knappen .

4 . Tredjepartsleverantörer: Identifiering , analys och urval

( Framförd av klient / projektägare )

Denna uppgift kräver forskning , identifiering och urval av tredjepartsleverantörer , produkter och tjänster såsom : Web Application Development Company - för detaljerad information : Hur Hyra en bra Web Application Development Company Konto och betalning gateway - för detaljerad information : Guide till Merchant Accounts och Gateways Betalning SSL-certifikat ( t.ex. leverantörer : Verisign , GeoTrust ) Managed Server / Colocation Server Provider - för detaljerad information : Managed Hosting Jämförelse Server , nätverk , brandvägg , lastbalanse Equipment ( kanske inte behövs om du använder en hanterad server - exempel : Dell, Cisco 5520 Load Balancer )

Fulfillment Centers ( exempel : Shipwire )

5 . Teknik Selection , tekniska specifikationer , Web Application struktur och tidslinjer

( Framförd av Comentum ) Detta dokument är en plan för teknik -och plattforms val , utvecklingsmiljö , webb applikationsutveckling struktur och ramar . Den tekniska specifikationer Dokument kommer detalj ut den teknik som används , licenser, versioner och prognoser . Tidslinjen dokument kommer att identifiera de slutdatum för Web Application funktioner eller moduler .

6 . Användning Visual Guide , Design Layout , gränssnittsdesign , Wire inramning

( Skapad av samarbete för projektägaren och Comentum ) En av de viktigaste ingredienserna för ett lyckat projekt är att sätta ihop en webbapplikation som använder en användares interaktion , gränssnitt och element som har en väl dokumenterad för enkel användning , och ge den bästa användarupplevelsen . Denna process börjar med att skapa den visuella guiden , tråd inramning eller bara skissa på användargränssnittet och interaktioner av webbapplikationermed Comentum s kreativa och användbarhet expertgrupper . När Application Interface och interaktion modeller är godkända , Comentum kreativa team designa gränssnitt för webbapplikationen .

7 . Web Application Development

( Utfört av Comentum s utvecklingsteam ) Programmets Design Interface vänds till Comentum s utvecklingsteam som vidta följande åtgärder för att utveckla projektet : Skapa Web Application Architecture och Framework Utforma databasstrukturen Utveckla / Anpassa Web Application Module , bibliotek och klasser Fyll i utveckling och genomföra alla Funktioner - Version 1.0

8 . Beta testning och felrättning

( Utfört av Comentum s betatestare ) Comentum s kraftig kvalitetstester försäkran hjälp producera de mest säkra och pålitliga webbapplikationer . Version 1.0 av Web Application är noggrant testad och eventuella program buggar åtgärdas och fasta .