Как я могу ссылаться на документацию по программному обеспечению?

В качестве дипломной работы я разрабатываю некоторое программное обеспечение (моделирующий фреймворк для MATLAB). Таким образом, мне часто приходится обращаться к документации по программному обеспечению — как из MATLAB, так и из программного обеспечения, которое служит моим источником вдохновения. Также было бы неплохо иметь возможность ссылаться на документацию конкретной функции, на которую я ссылаюсь (аналог ссылки на конкретную страницу в книге). Тем не менее, я в основном получаю доступ к этой документации в Интернете, и по своей природе она имеет тенденцию существовать только в электронной форме, что на самом деле не рекомендуется для публикации. Пока лучшее, что я придумал, это:

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

(строго говоря, это не часть официальной документации, но служит той же цели: это конкретная страница, доступная только в Интернете)

Конкретные вопросы:

  • Кто должен быть автором? В случае с MATLAB, я думаю, это Mathworks или что-то в этом роде; Я думаю, что перечисление проектов с открытым исходным кодом как «xx разработчиков» — это лучшее, что я могу сделать.
  • Как я должен указать версию? Urldate помогает в целом, но если я имею в виду конкретную версию программного обеспечения, где мне разместить эту информацию? В названии?
  • Существуют ли какие-либо «официальные» рекомендации по цитированию MATLAB? MATLAB часто используется в исследованиях, возможно, есть предложенный способ сделать это, и я просто его упускаю. Однако остальная часть вопроса по-прежнему актуальна для другого программного обеспечения.
Связанный (дубликат?): academia.stackexchange.com/q/5482/102
Также несколько связано: academia.stackexchange.com/questions/8098/…
проекты с открытым исходным кодом часто говорят вам, как цитировать, например, matplotlib.org/citing.html
«Сделай все, что в твоих силах, и не слишком беспокойся об этом». Это были официальные указания относительно интернет-ресурсов до того, как Академия начала догонять технологии и понимать, что веб-сайты интересны. Если у вас есть что-то, что не имеет категории, просто выберите другой формат, в котором есть некоторые правила, и адаптируйте его как можно лучше. Если нет четко совпадающих инструкций, большинство оценщиков не будут наказывать вас за то, что не имеет четких инструкций/прецедентов. Если вас будет оценивать/оценивать кто-то, кто может оказать вам поддержку заранее, проверьте свои результаты перед отправкой.

Ответы (2)

В общем, я бы рассматривал документацию по программному обеспечению в зависимости от того, как оно распространяется.

  • Если она опубликована в виде книги, то она должна цитироваться как книга. Номер версии указывается там, где вы бы поместили выпуск, а компания, производящая программное обеспечение, является «издателем».

  • Если руководство распространяется в электронном виде, в качестве «источника» следует указать веб-сайт, с которого оно получено.

  • Исключением является ситуация, когда в документации вас просят ссылаться на конкретную работу (например, научную статью или веб-сайт) при цитировании кода. Затем вы должны следовать конкретным указаниям.

что с автором? В некоторых институтах нам нужно цитировать как Author-Dateи таким образом ссылка не будет иметь автора

В дополнение к ответу @aeismail:

  • В моей области принято ссылаться на Matlab в тексте «Matlab версии XY (The Mathworks, USA)».

  • как комментирует @Bitwise, научный FOSS часто указывает, как цитировать. Поэтому мы ссылаемся, например, на R как на обычную книгу. Рекомендуемая ссылка R включает версию.

  • Если версия не включена в рекомендуемую цитату, я помещаю ее в поле примечания (Bibtex) — это способ R объединять такие цитаты:

    > 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},
  }

  • Если есть «обычная» публикация, я комбинирую обычные данные цитирования с дополнительным URL-адресом и информацией о версии:

    > 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},
  }

    (Здесь мне не нужна дополнительная дата, потому что дата выпуска включена в номер версии.

  • Я использовал другое программное обеспечение FOSS, спецификации которого я не нашел, поэтому я спросил разработчиков, как они хотят, чтобы их цитировали.
    Опыт показывает, что разработчики обычно очень довольны такого рода вопросами.

Как я могу ссылаться на документацию по программному обеспечению?
СпросиСетьПолитика конфиденциальности1y, 0v