Come documentare un design orientato agli oggetti nel testo

Naviga le tue risposte
5

Per il mio prossimo progetto, sto cercando di documentare il mio progetto Object Oriented in un testo semplice prima di saltare la pistola per codificarlo. Voglio farlo per due motivi.

  1. Voglio dare una riflessione adeguata al mio design ed eventualmente rivederlo più volte.
  2. Non ho esattamente deciso in quale lingua voglio implementare il mio progetto.

Sto cercando una convenzione per delineare il mio progetto in un testo semplice, anziché in un diagramma UML. Mi piace la comodità del testo. Posso controllare la versione e inserire facilmente un blog o wiki per condividerlo.

Sto pensando qualcosa di conciso, ad es. come potresti codice in Python. Tuttavia, voglio che la rappresentazione sia indipendente dalla lingua. Ho guardato in Internet ma non ho trovato nulla. Il più vicino sarebbe probabilmente il modo in cui proprietà e metodi sono definiti nella casella che rappresenta una classe in un modello UML.

Aggiornamento: Volevo solo chiarire "in testo". Il mio obiettivo è essere in grado di delineare il modello di oggetto in un wiki di github. Immagino che sia una specie di design open source oltre al codice. Quindi, posso creare una pagina Wiki per entità e identificare le relazioni usando i link e la formattazione, ecc. Tuttavia, quello su cui volevo dei suggerimenti era come delineare le specifiche di un'entità sulla sua pagina.

    
posta Danish 17.07.2012 - 20:31
fonte

3 risposte

6

È possibile scrivere in HTML e utilizzare collegamenti ipertestuali per esprimere relazioni tra classi diverse. Il problema, tuttavia, è che non puoi vedere link. Quando documenta un design, le relazioni sono una parte importante di ciò che stai cercando di spiegare, quindi non lo farà per renderle invisibili.

Suggerirei di dimenticare il testo normale. Usa HTML al minimo e non aver paura di includere le immagini create nel tuo strumento di disegno / grafica preferito. Questi potrebbero non essere così universali come testo normale, ma sarai comunque in grado di visualizzarli in qualsiasi browser, e dovresti comunque essere in grado di rintracciarli in un sistema di controllo della versione.

    
risposta data 17.07.2012 - 22:29
fonte
1

Abbiamo avuto un grande progetto e ho documentato tutte le funzioni dello sportello utilizzando Use Cases. Quindi abbiamo avuto un deposito, un prelievo, ecc. Con ognuno di essi ha avuto diversi processi locali, mid e back-end da passare. A vari livelli ho anche avuto accesso cambiando con la sicurezza. I casi d'uso hanno reso tutto ciò abbastanza chiaro e ti permettono di documentare non solo il sistema ma anche i giocatori coinvolti. Aiuta a determinare quali aree sono necessarie per progettare le librerie di classi e quale sicurezza diversa entra in gioco.

Questa visualizzazione di alto livello rende molto facile a) documentare ciò che sta accadendo, nonché b) identificare potenziali sottosistemi che è necessario progettare / costruire. A lungo termine, renderà il tuo prossimo livello di design molto migliore (IMHO).

    
risposta data 17.07.2012 - 22:24
fonte
0

Le cose più vicine a ciò che vuoi sono Use Cases. Rappresentano una rappresentazione testuale dei requisiti, delle idee e del design della tua applicazione. Una semplice spiegazione può essere trovata qui su wikipedia.

Tuttavia, per la migliore documentazione, consiglio il Caso di scrittura di casi d'uso di Alistair Cockburn

.     
risposta data 17.07.2012 - 21:48
fonte

Leggi altre domande sui tag

Dovrebbe esserci più studio scientifico sull'efficacia di varie idee truccate nello sviluppo del software? Quale tecnologia può eseguire il rendering di ambienti 3d su scala media in un browser Web [chiuso]