nfdi4plants / dataplan

DataPLAN is the Data Management Plan (DMP) generator developed in DataPLANT
https://nfdi4plants.github.io/dataplan/
GNU General Public License v3.0
1 stars 3 forks source link

Improve documentation / wiki #3

Closed Brilator closed 4 weeks ago

Brilator commented 1 year ago

This project could need a bit more documentation. So, apart from the tutorial (this is how), maybe share some documentation on the individual sections, why the questions might be asked (e.g. from DFG) and more importantly how my selection / edited data in the sidebar affects / changes the DMP (although this could eventually be read from the DMP once finished).

Brilator commented 1 year ago

Some examples:

Where will you submit your data as endpoints?

What is an "endpoint" and how do I know which one is important for my data?

Are there any standards that are relevant for you?

What are standards? What is MIAPPE, MINSEQE, Dublin Core? How do I find out wether these are relevant for my project?

When will you make your data public? Will you publish your data early?

When is early?

Brilator commented 1 year ago

2

1

xiaoranzhou commented 1 year ago

This project could need a bit more documentation. So, apart from the tutorial (this is how), maybe share some documentation on the individual sections, why the questions might be asked (e.g. from DFG) and more importantly how my selection / edited data in the sidebar affects / changes the DMP (although this could eventually be read from the DMP once finished).

Programming documentation is absolutely a TODO. The others were written in a manuscript draft.

AngelaKranz commented 2 months ago

This issue is still open. @xiaoranzhou: Is this still being worked on?

xiaoranzhou commented 2 months ago

This can be closed in my point of view because we have knowledge base articles now. https://www.nfdi4plants.de/nfdi4plants.knowledgebase/docs/implementation/DataPLAN.html

xiaoranzhou commented 4 weeks ago

I will close this one as the knowledgebase article has been online for a while.