Kandidaatin tutkielmanani kehitän joitain ohjelmistoja (MATLAB: n pilkkaavat puitteet). Sellaisenaan minun on usein viitattava ohjelmistodokumentaatioon – sekä MATLAB: lta että ohjelmistosta, joka toimii inspiraationani. Olisi myös mukavaa, että voisin viitata sen ominaisuuden dokumentointiin, johon viittaan (analoginen viitata kirjan tiettyyn sivuun). Käytän kuitenkin enimmäkseen tätä dokumentaatiota verkossa ja luonteeltaan sillä on taipumus olla olemassa vain sähköisessä muodossa, jota ei oikeastaan suositella julkaisemisessa. Toistaiseksi olen keksinyt tämän:
@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 tarkkaan ottaen , tämä ei ole osa virallisia asiakirjoja, mutta sillä on sama tarkoitus: se on tietty sivu ja se on saatavana vain verkossa)
Erityiskysymykset:
- Kenen pitäisi olla kirjoittaja? MATLAB: n tapauksessa luulen sen olevan Mathworks tai somsuch; Luulen, että avoimen lähdekoodin projektien mainitseminen ”xx-kehittäjinä” on paras mitä voin tehdä.
- Kuinka minun pitäisi mainita versio? Urldate auttaa yleensä, mutta jos viittaan tietty ohjelmistoversio, mihin minun pitäisi laittaa nämä tiedot? Otsikkoon?
- Onko ”virallisia” MATLAB-lainaussuosituksia? MATLABia käytetään tutkimuksessa paljon, ehkä siellä on ehdotettu tapa tehdä se ja minusta puuttuu vain se. Loput kysymys koskee kuitenkin muita ohjelmia.
kommentit
- Liittyvät (kopio?): academia.stackexchange.com/q/5482/ 102
- Liittyy myös jonkin verran: academia.stackexchange.com/questions/8098/…
- avoimen lähdekoodin projektit kertovat sinulle usein, kuinka lainata, esim. matplotlib.org/citing.html
- " Tee parhaasi ja älä ' t huolehdi siitä liikaa. " Nämä olivat virallisia ohjeita Internet-resursseista, ennen kuin Academia alkoi tarttua tekniikkaan ja huomata verkkosivustojen olevan mielenkiintoisia. Jos sinulla on jotain, jolla ei ole luokkaa, valitse vain toinen muoto, jolla on joitain sääntöjä, ja sopeudu mahdollisimman hyvin. Jos mikään ohje ei vastaa selvästi, useimmat tiehöylät ' eivät rankaise sinua jostakin, jolla ei ole selkeitä ohjeita / ennakkotapauksia. Jos sinua arvioi / arvioi joku, joka voi tarjota sinulle tukea etuajassa, tarkista tulokset ennen lähettämistä.
Vastaa
Yleensä käsittelen ohjelmistodokumentaatiota sen mukaan, miten se jaetaan.
-
Jos se julkaistaan kirjamuodossa, se on mainittava kirjana. Versionumero menee sinne, missä laitat painoksen, ja ohjelmiston valmistava yritys on ”julkaisija”.
-
Jos käyttöohjetta jaetaan sähköisesti, sinun on mainittava verkkosivusto, jolta se on hankittu ”lähteenä”.
-
Poikkeus tähän on, jos sinua pyydetään dokumentaatiossa viittaamaan tiettyyn teokseen (esimerkiksi tutkimusartikkeli tai verkkosivusto) kun viittaat koodiin. Sitten sinun tulee noudattaa annettuja ohjeita.
Vastaa
Lisäksi @aeismail ” vastaus:
- Alallani on yleistä viitata Matlabiin tekstissä ”Matlab-versio XY (The Mathworks, USA)”
-
nimellä @Bitwise kommentit, tieteellinen FOSS määrittelee usein kuinka lainata. Viittaamme esimerkiksi R: hen normaalina kirjana. R: n suositeltu viittaus sisältää version.
-
Jos versiota ei sisälly suositellun lainauksen, laitoin sen muistiinpanokenttään (Bibtex) – se on R-tapa koota tällaiset lainaukset:
> citation ("cbmodels") To cite package ‘cbmodels’ in publications use: C. Beleites (2013). cbmodels: Collection of "combined" models: PCA-LDA, PLS-LDA, etc.. R package version 0.5-20130417. A BibTeX entry for LaTeX users is @Manual{, title = {cbmodels: Collection of "combined" models: PCA-LDA, PLS-LDA, etc.}, author = {C. Beleites}, year = {2013}, note = {R package version 0.5-20130417}, } -
Jos julkaisu on ”normaali”, yhdistän normaalit viittaustiedot muihin URL-osoitteisiin ja versiotietoihin:
> citation ("softclassval") To cite package "softclassval" please use: Claudia Beleites, Reiner Salzer and Valter Sergo: "Validation of Soft Classification Models using Partial Class Memberships: An Extended Concept of Sensitivity & Co. applied to grading of astrocytoma tissues", Chemometrics and Intelligent Laboratory Systems, 122 (2013), 12 - 22, DOI: 10.1016/j.chemolab.2012.12.003, arXiv: 1301.0264, R package version 1.0-20130318, http://softclassval.r-forge.r-project.org. A BibTeX entry for LaTeX users is @Article{, title = {Validation of Soft Classification Models using Partial Class Memberships: An Extended Concept of Sensitivity & Co. applied to Grading of Astrocytoma Tissues}, author = {Claudia Beleites and Reiner Salzer and Valter Sergo}, year = {2013}, number = {122}, pages = {12 -- 22}, journal = {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}, }(tässä, en aio ” Ei tarvitse lisäpäivää, koska julkaisupäivä sisältyy versionumeroon.
-
Olen käyttänyt muuta FOSS-ohjelmistoa, josta en löytänyt eritelmää, joten kysyin develo henkilöt kuinka he haluavat tulla lainatuiksi.
Kokemus on, että kehittäjät ovat yleensä erittäin tyytyväisiä tällaiseen kysymykseen.