joss icon indicating copy to clipboard operation
joss copied to clipboard

[WIP] Stubbing out docs for paper preparation

Open arfon opened this issue 5 years ago • 5 comments

I'd like to write some better documentation to help authors preparing JOSS papers. For most authors this is a pretty straightforward process, but when it goes wrong, or authors have more specialist needs for their papers, we don't have very good documentation to support them.

I'd be interested to hear from @openjournals/joss-editors what they think we should try and capture here based on their experiences.

/ cc #553

arfon avatar Jun 30 '19 11:06 arfon

Good points @arfon! I guess that alongside the docs, an insanely complete example that authors can just delete sections off of would help a lot, i.e:

https://gist.github.com/marktheunissen/2979474

... since in this day and age, fewer and fewer people actually read docs, unfortunately ;)

brainstorm avatar Jul 01 '19 00:07 brainstorm

https://gist.github.com/marktheunissen/2979474

Yeah, that's a great idea. We could easily update the example paper to be a 'feature complete' one like you suggest.

arfon avatar Jul 01 '19 01:07 arfon

Also (perhaps for a separate PR) it would be nice to include some information about joint submissions between an AAS journal and JOSS. The JOSS blog post announcing this partnership says:

Any submission to JOSS that has come via AAS will be clearly marked as such in the review process. We’ll create some additional documentation on https://joss.readthedocs.io explaining what’s going on.

mbobra avatar Jul 01 '19 17:07 mbobra

Also (perhaps for a separate PR) it would be nice to include some information about joint submissions between an AAS journal and JOSS. The JOSS blog post announcing this partnership says:

👍 great idea.

arfon avatar Jul 01 '19 18:07 arfon

Hey there @arfon 👋 I saw your pull request after creating my own on adding a TiKZ example to the demo paper.md file 🤓 This is a nice pull request, good work 👍

pedramardakani avatar Nov 25 '22 10:11 pedramardakani