PTC Recommendation : Software Citation in a project

[rinkug]

Name and Description

SoftwareCitation: Getting a software citation for your project

User Story: As a team lead , I want to provide citations for our software, so that our software is easily discoverable, creators on my team get due credit and reproducibility with my software becomes easier

Card(s)

0. Project does not incorporate citations for their software
1. Investigate the different venues that provide software citations and chooses one that meets your needs
2. Complete requirements for software citation and get a citation for the software
3. Use the citation at outreach venues (presentations, publications)
4. Team documents are updated to educate all team members on how to get and use citations
5. Team evaluates trends/success of chosen citation method and make a decision to continue or seek newer methods.

Comments

Guidelines for above steps
For Step 1 (Investigate the different venues that provide software citations and chooses one that meets your needs), some of the links on bssw.io may be useful

• https://bssw.io/items/what-is-work-on-software-publishing-and-citation
• https://bssw.io/items/introducing-the-force11-software-citation-implementation-working-group
• https://bssw.io/items/where-and-how-to-publish-cse-software
• https://bssw.io/events/webinar-software-citation-today-and-tomorrow

For Step 3 (Use the citation at outreach venues (presentations, publications))

• This may be a long term step. What needs to be evaluated in this step, is how easy it is to use the particular citation method in your outreach materials, if other publications are using citations to cite your work. It may be too early to determine if a software citation is being useful to your project.

For Step 4 (Team documents)

• Team documents here refers to any portals/documents that are used by the team to disseminate information among themselves. Examples of such documents can be software release policies, checklists, guides etc.

Related Cards

None for now

Other Remarks

Please feel free to make each of the bullets more broader.

[elaineraybourn]

This is a good start at a task list that can be associated with a progress tracking card. PTCs articulate the behaviors that are evident at the stages of the activity, and what constitutes completeness at each stage. Try writing the PTC in past or past perfect tense, and focus on answering the question, "at this stage, given the associated steps have been performed, what artifacts will we have that signal that at this stage the activity is complete? For instance, your step 1 "Investigate the different venues that provide software citations and chooses one that meets your needs" could be rewritten as "Team has made decision on software citation protocol after investigation and documentation of needs." Reach out if you have more questions.

[elaineraybourn]

@rinkug please see my comment on December 18. Would you like to modify your PTC?