Domanda:
Come posso citare la documentazione del software?
VPeric
2013-04-24 23:43:01 UTC
view on stackexchange narkive permalink

Come tesi di laurea, sto sviluppando un software (un framework beffardo per MATLAB). Pertanto, spesso ho bisogno di fare riferimento alla documentazione del software, sia da MATLAB che dal software che mi serve da ispirazione. Sarebbe anche bello poter fare riferimento alla documentazione della caratteristica specifica a cui mi riferisco (l'analogo del riferimento a una pagina specifica in un libro). Tuttavia, per lo più accedo a questa documentazione online e per sua natura tende ad esistere solo in formato elettronico, il che non è realmente raccomandato nella pubblicazione. Finora, il meglio che ho trovato è questo:

  @misc {mockitoFeatures, author = {{\ em mockito} developers}, title = {Features and Motivations}, note = {\ url {https://code.google.com/p/mockito/wiki/FeaturesAndMotivations}}, urldate = {2013-04-24},}  

(ok in senso stretto , questo non fa parte dei documenti ufficiali ma ha lo stesso scopo: è una pagina specifica ed è disponibile solo online)

Domande specifiche:

  • Chi dovrebbe essere l'autore? Nel caso di MATLAB immagino che sia Mathworks o qualcosa del genere; Immagino che elencare i progetti open-source come "sviluppatori xx" sia il meglio che posso fare.
  • Come dovrei menzionare la versione? Urldate aiuta in generale, ma se mi riferisco a una particolare versione del software, dove devo inserire queste informazioni? Nel titolo?
  • Ci sono consigli "ufficiali" per citazioni MATLAB? MATLAB è usato molto nella ricerca, forse c'è un modo suggerito per farlo e mi manca solo esso. Il resto della domanda si applica comunque ad altro software.
Correlato (duplicato?): Http://academia.stackexchange.com/q/5482/102
Anche in qualche modo correlato: http://academia.stackexchange.com/questions/8098/how-to-cite-a-website-url/8112#8112
i progetti open source spesso ti dicono come citare, ad es. http://matplotlib.org/citing.html
"Fai del tuo meglio e non preoccuparti troppo." Queste erano le indicazioni ufficiali fornite sulle risorse Internet prima che Academia iniziasse a mettersi al passo con la tecnologia e rendersi conto che i siti web erano interessanti. Se hai qualcosa che non ha categoria, scegli semplicemente un altro formato che abbia alcune regole e adattalo nel miglior modo possibile. Se nessuna istruzione corrisponde chiaramente, la maggior parte dei selezionatori non ti penalizzerà per qualcosa che non ha istruzioni chiare / precedenti. Se stai per essere giudicato / valutato da qualcuno che può fornirti supporto in anticipo, controlla i risultati prima dell'invio
Due risposte:
aeismail
2013-04-25 00:17:40 UTC
view on stackexchange narkive permalink

In generale, tratterò la documentazione del software a seconda di come è distribuito.

  • Se è pubblicato in forma di libro, dovrebbe essere citato come un libro. Il numero della versione va dove metteresti l'edizione e la società che produce il software è l '"editore".

  • Se il manuale è distribuito elettronicamente, dovresti citare il sito web da cui è ottenuto come "fonte".

  • Un'eccezione è se nella documentazione viene chiesto di fare riferimento a un lavoro specifico (ad esempio, un articolo di ricerca o un sito Web) quando si cita un codice. Quindi dovresti seguire la guida specifica fornita.

cbeleites unhappy with SX
2013-04-26 17:50:02 UTC
view on stackexchange narkive permalink

Oltre alla risposta di @ aeismail:

  • Nel mio campo è comune fare riferimento a Matlab nel testo "Matlab version XY (The Mathworks, USA)"
  • come commenta @Bitwise, FOSS scientifico spesso specifica come citare. Quindi ci riferiamo ad es. a R come un normale libro. La citazione consigliata di R include la versione.

  • Se la versione non è inclusa nella citazione consigliata, la metto nel campo della nota (Bibtex): questo è il modo R di mettere insieme citazioni di questo tipo:

      > citation ("cbmodels") Per citare il pacchetto "cbmodels" nelle pubblicazioni, utilizzare: C. Beleites (2013). cbmodels: raccolta di modelli "combinati": PCA-LDA, PLS-LDA e così via. Pacchetto R versione 0.5-20130417. Una voce BibTeX per gli utenti LaTeX è @ Manual {, title = {cbmodels: raccolta di modelli "combinati": PCA-LDA, PLS-LDA, ecc.}, Autore = {C. Beleites}, year = {2013}, note = {R package version 0.5-20130417},}  
  • Se c'è una pubblicazione "normale", combino il dati di citazioni normali con URL aggiuntivi e informazioni sulla versione:

      > citation ("softclassval") Per citare il pacchetto "softclassval" si prega di utilizzare: Claudia Beleites, Reiner Salzer e Valter Sergo: 'Validation of Soft Classification Modelli che utilizzano appartenenze a classi parziali: un concetto esteso di sensibilità & Co. applicato alla classificazione dei tessuti di astrocitoma, Chemometrics and Intelligent Laboratory Systems, 122 (2013), 12-22, DOI: 10.1016 / j.chemolab.2012.12.003, arXiv : 1301.0264, pacchetto R versione 1.0-20130318, http: //softclassval.r-forge.r-project.org Una voce BibTeX per gli utenti LaTeX è @Article {, title = {Validation of Soft Classification Models using Partial Class Memberships: Un concetto esteso di sensibilità & Co. applicato alla classificazione dei tessuti di astrocitoma}, autore = {Claudia Beleites an d Reiner Salzer e Valter Sergo}, anno = {2013}, numero = {122}, pagine = {12 - 22}, rivista = {Chemometrics and Intelligent Laboratory Systems},
    note = {R package version 1.0-20130318}, url = {http://softclassval.r-forge.r-project.org}, doi = {10.1016 / j.chemolab.2012.12.003}, eprint = {http: //arxiv.org/abs/1301.0264},}  

    (Qui, non ho bisogno di una data aggiuntiva, perché la data di rilascio è inclusa nel numero di versione.

  • Ho utilizzato altri software FOSS in cui non ho trovato una specifica, quindi ho chiesto agli sviluppatori come vogliono essere citati.
    L'esperienza è che gli sviluppatori di solito sono molto felice per questo tipo di domanda.



Questa domanda e risposta è stata tradotta automaticamente dalla lingua inglese. Il contenuto originale è disponibile su stackexchange, che ringraziamo per la licenza cc by-sa 3.0 con cui è distribuito.
Loading...