Develop content template

data2health / informatics-playbook

A collaborative guidebook for reusable data best practices

12 stars 5 forks source link

Develop content template #1

Closed kristiholmes closed 5 years ago

kristiholmes commented 5 years ago

(scroll to the bottom of this page for more robust descriptions of the chapter elements) template - fork and write the chapter

Draft chapter structure

Why is this important? - statement to provide context
Topic Takeaways - a bulleted list of things you can read and implement (similar to top 10 PLoS Top 10 articles)
Introduction
Deep Dive into Takeaways
Usecase(s)
Summary

kristiholmes commented 5 years ago

seeking input on this draft structure from @newgene @mellybelly @KenGersing from @rchampieux @kristiholmes

Please weigh in by the end of day, May 10 with comments or other input so that we can craft the pilot chapter.

kristiholmes commented 5 years ago

Hi all - please take a look at these sections and see if this fits the desired framework for the best practices guidebook. Once we get the OK, we will recruit a sample chapter to serve as a reference. Please comment below...

[ ] Why is this important? (statement to provide context)
[ ] Topic Takeaways (a bulleted list of things you can read and implement, similar to PLoS Top 10 articles)
[ ] Introduction (problem statement, background, relevant contextual information)
[ ] Deep Dive into Takeaways (if needed; space for discussion, lessons learned, caveats, etc. as necessary for the Topic Takeaways)
[ ] Usecase(s) (it is always great to get an idea of who this information would be useful to in the wild)
[ ] Summary (if needed; wrap it up)
[ ] Acknowledgements (give credit for relevant funding, helpful colleagues, inspirations, etc.)

CC: @newgene @mellybelly @KenGersing @rchampieux @kristiholmes @data2health/pi

mellybelly commented 5 years ago

I think we should provide guidance on the use cases. There should be implementation examples. The summary may not be necessary if we have the topic takeaways (also these can link down into deeper content in the deep dive section).

mellybelly commented 5 years ago

@RoseRelevo, @cgcook, or @newgene can you implement the above structure minus the summary + methods/evidence for all promised chapters? @RoseRelevo please make final comments about this latter point. All pls see #10 for info on the evidence.

RoseRelevo commented 5 years ago

Examples should not simply demonstrate that such a thing can be done, it should at least offer some insight as to why doing it one way (vs. another) is better.

Once any chapter or topic gets to be flushed out, I will be able to identify any current guidance or examples in the literature.

https://www.ncbi.nlm.nih.gov/books/NBK47095

This is AHRQ's methodological guidance, we've only been working on it for about 10 years :)