Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.
Sign upGoal of this A&P document/process #62
Comments
danielskatz
added
the
A&P doc discussion
label
Oct 4, 2018
This comment has been minimized.
This comment has been minimized.
AlastairKelly
commented
Oct 4, 2018
I think primarily it is that fourth bullet point: A way to organize guidance that we provide to others, and to explain where we still have questions and uncertainties. I think community-specific examples will be part of that. (fifth bullet) |
This comment has been minimized.
This comment has been minimized.
I believe the document should be next step after the software citation principles on how to cite software. In the principles a couple of citation use cases are described an a set of guiding principles were defined. i agree with @AlastairKelly, that it will be also great to unify our language with this document, even if we don't agree on the usage of every term, we will have some clear definitions. |
This comment has been minimized.
This comment has been minimized.
lkellogg
commented
Nov 12, 2018
I suggest that we have a subsection of the Introduction (Section 1) called "Purpose and Goals of this Document". The idea would be to help readers identify who should read this document and how they should use it. For example: software developers: they will use this document to stay up to date on practices they should be using. Editors of journals or peer-reviewers: they will use this document to see if the software used in publications is being cited properly. And so on. There is currently some info about this in Section 6.1 (still in list rather than narrative form). |
This comment has been minimized.
This comment has been minimized.
On the call, @lkellogg @dbouquin @npch and @danielskatz suggested that the document should be aimed primarily at those stakeholders who had a level of expertise or championing that was above that of the "ordinary" person who wished to understand how to do a specific software citation use case (these people would be pointed to other slimmer, more specific primers). These people might be those at communities, institutions or journals who support researchers, or software citation champions. It would present a view of the current state of software citation practice and enable these stakeholders to get up to speed with the current practice of software citation, the language and terminology that is being used, and the challenges that are still to be addressed. (NB: I think of this as being the difference between user documentation and developers documentation) |
This comment has been minimized.
This comment has been minimized.
Another question is where this document goes, what we do with it, and how updates/follow-ons are made: Options
Ideas:
|
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Draft: |
This comment has been minimized.
This comment has been minimized.
ljhwang
commented
Dec 5, 2018
Some questions to consider:
Are we comfortable that Closed Source is always associated with a Company? In both cases is “entity” (or another term) perhaps a better generalization?
Similarly, are we comfortable citing specific technologies? For example, is Software Heritage the only or just best method to achieve goals?
Best,
-Lorraine
*****************************
Lorraine Hwang, Ph.D.
Associate Director, CIG
530.752.3656
… On Dec 4, 2018, at 7:08 AM, Daina Bouquin ***@***.***> wrote:
Updated diagram
<https://user-images.githubusercontent.com/5713878/49451115-78ec7c80-f7ac-11e8-8c53-f95690d886e2.jpg>
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub <#62 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AESQX22ghZY8xgeIvjc9Z85H9lcuva0Nks5u1o_TgaJpZM4XIMmy>.
|
This comment has been minimized.
This comment has been minimized.
I don't see what you are referring to, can you tell me what section(s)? In general, I agree with you.
Good question - right now, it seems like the only way, but we should probably generalize a little too. |
This comment has been minimized.
This comment has been minimized.
ljhwang
commented
Dec 18, 2018
wrt "Company" - The comment was probably tied to your comments in section 3.1 from the point of naivete on what else may fall under this category and how they may track releases. Are there noncorporate entities that have closed source software? |
This comment has been minimized.
This comment has been minimized.
I feel like the "perhaps" language makes this ok. If you have something additional to suggest to make this clearer, please make a suggestion in the document. |
danielskatz commentedOct 4, 2018
Based on discussion in Section 1 of A&P google doc