Domande taggate «documentation»

La documentazione del software è un testo scritto che accompagna il software del computer. Spiega come funziona il software, come installarlo, come usarlo e altre risorse di aiuto.

14
Qual è l'avversione alla documentazione nel settore?
Sembra esserci un'avversione nello scrivere anche la documentazione più elementare. I nostri README di progetto sono relativamente spogli. Non ci sono nemmeno elenchi aggiornati di dipendenze nei documenti. C'è qualcosa di cui non sono a conoscenza nel settore che non piace ai programmatori scrivere documenti? Posso scrivere paragrafi di documenti …
6
"I", "We" o Né nella documentazione del codice
Mi ritrovo a scrivere (si spera) utili commenti nella documentazione del codice (C ++) del tipo: The reason we are doing this is... Il motivo per cui uso "noi" anziché "io" è perché faccio molta scrittura accademica dove "noi" è spesso preferito. Quindi ecco la domanda. C'è un buon motivo …
12
La documentazione in OOP dovrebbe evitare di specificare se un "getter" esegue o meno un calcolo?
Il programma CS della mia scuola evita qualsiasi menzione di programmazione orientata agli oggetti, quindi ho fatto alcune letture per conto mio per integrarlo - in particolare, la costruzione di software orientata agli oggetti di Bertrand Meyer. Meyer sottolinea ripetutamente che le classi dovrebbero nascondere quante più informazioni possibili sulla …
6
Formato foglio di calcolo Git-friendly? [chiuso]
Stiamo provando a spostare il nostro processo di documentazione del progetto da Google Documents a una serie di repository Git self-hosted. I documenti di testo sono abbastanza adatti a Git, dal momento che di solito non abbiamo bisogno di alcuna formattazione elaborata, convertiremo tutto in, diciamo, multimarkdown con un'opzione per …
9
Le persone non IT possono gestire un wiki? [chiuso]
La mia azienda sta cercando di migliorare la gestione dei dati delle ricerche di mercato. Stile di gestione dei dati attuale: "Ehi Jimbo, dov'è quella foto del nostro WhatZit 2.0? "sì, ricordo quell'email su quell'azienda di quel ragazzo, dammi qualche minuto per cercare nel mio Outlook" "chi ha la copia …
3
Quali blocchi stradali devono affrontare il processo di sviluppo nell'uso di linguaggi di markup in testo semplice rispetto, ad esempio, a Microsoft Word? [chiuso]
Attualmente sono stagista presso un appaltatore governativo e ho la sensazione (odiosamente inevitabile) che Word sia lo standard di fatto nel processo di sviluppo del software. Il suo formato binario rende molto difficile collaborare ai documenti nel modo in cui sono abituato a collaborare su una base di codice. L'uso …
3
Origine di "Readme"
Quando le persone hanno iniziato a scrivere file Leggimi? Sembra che praticamente tutti i programmi abbiano questo file, indipendentemente dal formato. Esiste un primo utilizzo documentato di questo documento?
5
Progettare documenti come parte di Agile
Nel mio posto di lavoro, affrontiamo una sfida in quanto "agile" troppo spesso ha significato "requisiti vaghi, criteri di cattiva accettazione, buona fortuna!" Stiamo cercando di affrontarlo, come uno sforzo di miglioramento generale. Quindi, come parte di ciò, sto proponendo di generare documenti di progettazione che, al di là del …
7
Rilasciare prima o documentare prima?
Lavoro a un progetto da un paio d'anni e sto iniziando a raccogliere una base di utenti decente. Ho creato una pagina di progetto con alcuni documenti di base, ma a questo punto in realtà non è molto più di una FAQ. So che devo migliorarlo in modo che sia …
Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.