Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Software documentation #11

Open
15 tasks
j-i-l opened this issue Feb 13, 2024 · 0 comments
Open
15 tasks

Software documentation #11

j-i-l opened this issue Feb 13, 2024 · 0 comments
Assignees
@j-i-l
Milestone
JOSS paper submis...

Comments

@j-i-l
Copy link
Collaborator

j-i-l commented Feb 13, 2024 •
edited
Loading

See the relevant section in the JOSS review criteria.

The following elements are required in an adequate documentation:

  • README.md providing at least
    • high level overview
    • links to all other items of the documentation)
  • A statement of need to clarify
    • What problems this software is designed to solve
    • Who is the target audience
    • Mention related other work
  • Installation instructions
    • handled by package manager
    • explicitly state dependencies (plus how to install them)
  • Example usage
  • API documentation of all exposed functions
    • Minimal description of the purpose
    • Declare input and outputs
    • Provide basic application example
  • Community guidelines
    • How to proceed in order to contribute to this software
    • How to report issues, problems and suggestions
    • Where/How to seek for support

We need to decide how we want to structure this documentation, i.e. what should reside directly in the README.md, what in some online documentation and what parts should reside just within the repository.
@j-i-l j-i-l added this to the JOSS paper submission milestone Feb 13, 2024
@j-i-l j-i-l self-assigned this Aug 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@j-i-l j-i-l

Labels
None yet
Projects
None yet
Milestone
JOSS paper submission
Development

No branches or pull requests
1 participant
@j-i-l