Qual è il modo migliore per archiviare la documentazione associata a un progetto di codice?

Non sono sicuro che esista un singolo "modo migliore", ma dalla tua descrizione sembra che ogni sviluppatore stia facendo il proprio modo di archiviare la documentazione. Ottieni un buy-in da tutti con un unico metodo di archiviazione della documentazione, e sarà molto più facile mantenerlo organizzato.

Oltre alla risposta "trova il modo migliore per te", direi almeno cercare una soluzione che faciliti la ricerca di documenti . In una società, ho creato una wiki che conteneva collegamenti a file generati su serverland, il che ha reso improvvisamente molto più facile la ricerca e l'individuazione dei documenti, indipendentemente da dove si trovassero. Quando altri utenti hanno iniziato a utilizzare il wiki per trovare i documenti, hanno anche iniziato ad aggiornarlo per collegare nuovi documenti o semplicemente creando una voce wiki come documento.

Mi piacerebbe sapere da chiunque altro se sanno dei sistemi di controllo delle versioni gratuiti che funzionano bene con i documenti. L'unica cosa che mi viene in mente è Sharepoint, che non è esattamente libero. Ho visto sistemi di versioni non ufficiali in cui le persone hanno una cartella "Archivio" e semplicemente mettono le revisioni precedenti di un file in quella cartella, con la revisione più recente che si trova nello stesso livello di cartella di "Archivio".

La soluzione che ha funzionato al meglio nella mia azienda è stata la creazione di una wiki (usiamo mediawiki). Viene utilizzato in molti modi, dalle tradizionali voci wiki a un semplice "Questo è un ..." più un documento Word. È molto facile da cercare. Stiamo gradualmente creando un repository di informazioni molto utile.

Almeno in VS 2008, puoi impostare il tipo di configurazione di un progetto C ++ (sotto le proprietà del progetto- > general- > default del progetto) su Utility , in cui il caso VS non fa nulla con esso.

Hai provato a utilizzare un progetto del genere nella tua soluzione basata su C #? (Forse un progetto C # ha qualcosa di simile?)

Sono assolutamente d'accordo che non ci sia una sola soluzione migliore qui. Ma controllo della versione! = Incluso nella soluzione; la maggior parte dei sistemi è in grado di gestire le cose oltre l'IDE. Quindi si possono mantenere i documenti chiusi ma non nella maggior parte dei casi.

Ora, superare abitudini fastidiose di parole per cambiare file ogni volta che vengono aperti è un altro problema. . .

No, i progetti di Visual Studio (beh, C # e Vb.net) hanno un approccio cerebrale per il solution explorer. Il VC ++ è MOLTO meglio in quanto è possibile creare cartelle virtuali che non sono legate al layout del disco e inserire anche tutti i tipi di materiale. Silly Microsoft lo ha rotto cercando di renderlo 'più facile da capire'.

Puoi ancora metterlo in una 'cartella della soluzione' ma non è ancora così flessibile come probabilmente vorrai. Ciò significa che devi trovare un'alternativa e le mie alternative consigliate sono gli strumenti web. Se non si desidera provare un portale di progetto (come Redmine) in cui è possibile archiviare i documenti e avere un wiki, un bug tracker, ecc ecc, quindi utilizzare uno strumento di gestione dei documenti. Qualcosa come Nuxeo o Gufo ti farebbero bene. Una volta che è il web, hai una posizione centrale in modo che le persone sappiano dove cercare queste cose - questa è probabilmente la parte più importante della gestione dei documenti. Se lo leghi a un sistema di controllo della versione come subversion (continua, non te ne pentirai dopo VSS!), Quindi sarai ancora in grado di collegare i documenti agli strumenti web e anche la versione li controllerà.

Subversion ha persino la possibilità di esporre il repository come cartella webdav, ad esempio una cartella di rete, in modo che tu possa metterli in una "unità di rete" e mantenerli automaticamente controllati dalla versione.

Preferirei ancora Redmine come mia preferenza personale.