Sto lavorando alla creazione di un software e documentazione del prodotto in un formato wiki. Comprenderà la documentazione per tutti i prodotti dell'azienda.
Dopo alcune ricerche, abbiamo deciso di utilizzare la piattaforma MediaWiki e creare un wiki privato accessibile dalla nostra rete interna.
Questa documentazione includerà principalmente artefatti software per ora:
- Diagrammi del database;
- Dizionario dati con meta-dati del database;
- Breve descrizione del prodotto;
In futuro includerà anche:
- Artefatti e diagrammi UML;
- Use cases;
- Pagine di assistenza per il team di supporto;
- Segnalazioni di errori;
- Informazioni statistiche sul prodotto;
- Guide di prova;
La struttura wiki non è un problema, ma il mio primo pensiero è stato bloccare alcune pagine ad alcuni utenti specifici. A quanto pare, non è possibile utilizzare MediaWiki , quindi chiunque nella nostra rete interna potrà visualizzare tutta la documentazione, anche se non possono modificare.
La mia domanda è: C'è qualche problema nel mantenere questa documentazione pubblica per chiunque in azienda? Voglio dire, i documenti software sono importanti per gli sviluppatori e i team tecnici, ma il team di vendita, ad esempio, non ha bisogno di vedere tutte queste pagine, giusto? I dati statistici dovrebbero essere acessibili per gli sviluppatori? Dovrebbe essere pubblico?
La documentazione non includerà dati sensibili, come chiavi o password, ma mi piacerebbe sapere se esiste un approccio standard all'accesso alla documentazione nelle grandi aziende.
Ho trovato questi simili domande qui, ma riguardano la documentazione del codice e una discussione su l'uso di wiki per la documentazione, non è il mio caso.
In base ai commenti, ecco alcuni aggiornamenti :
Ho spiegato l'intera immagine, ma sono particolarmente preoccupato per eventuali problemi relativi all'accesso non autorizzato alla documentazione del software.
Quando ho iniziato il progetto di documentazione, ho pensato che nascondere alcune parti potrebbe essere un buon approccio, ma pensando (e cercando) su di esso, non ho trovato un modello.
Quindi, la mia domanda riguarda qualsiasi approccio standard (o raccomandato) usato dagli ingegneri del software per trattare la documentazione del software (interno). Ce ne sono?