Tutorials, content and documentation roadmap

[schae234]

Roadmap

This section contains an overview of items/issues related to the tutorials, documentation and any teachable content in this project. The discussion and issues described here are software agnostic. No coding experience or knowledge necessary! Project ideas and objectives will be described and planned out here. Objectives defined here will be shared with the software project sections (backend and frontend) who will implement the use cases (i.e. project objectives).

As issues are fleshed out, cross reference them here.

Use Cases:

Lets start with a few high level use cases!

NCBI Based tutorial (Issue #6)

• Create a NCBI tutorial/document that performs manual gene annotation without a website

This objective will help us flesh out what steps need to be taken to perform manual gene annotation without a fancy new website.

• Outline the steps that need to be taken for Exon identification

BLAST tutorial (Issue #7)

• Create a NCBI Blast based tutorial on how to compare sequence between human and horse

This objective will explain how to run and identify a BLAST search to compare gene sequence between human and horse

Multiple Sequence Alignment tutorial (Issue #8)

• Create a Multiple Sequence alignment (MSA) tutorial to compare gene sequence between horse and related organisms.

This objective will explain how to run a MSA search to compare gene sequence

Mock up (Issue #9)

• Create a mock-up of how these use cases could be covered by a website

[MollyMcCue-DVM-PhD]

One thing that I think we need to make easy is getting right to where users can edit the tutorial documents (i.e. a direct link, and editing in a familiar format). Getting users from the equine community like Mickelson to contribute to those docs via this GitHub platform or using MD is an unreasonable expectation in many ways due to the learning curve to get to where they can edit the documents. We need to come up with a way to simplify this most scientists are not going to see the value in learning GitHub just to contribute to this project--its too much work

[schae234]

Yes, this is possible but integrating something so that edits are automatically incorporated via Word Docs or another format will be extra overhead. There are word plugins that will convert between MD and doc files. You can also drag and drop word docs into github comments, which we might be able to leverage as a submission system.

But there has to be a middle ground somewhere? If we want true crowd-contributions, we need to be able to handle a crowd. Handling the one-off contribution thats outside of the guidelines is fine, but my worry is that if there are dozens of emails and docs flying around it gets unwieldy very quickly.

We can also make some more upfront guides (videos, step-by-steps, etc) on how to contribute through github and put those right at the top of all the "non-technical" sections.

[micke001]

The start off sentence "This project section contains content related to the project content" is kind of clumsy; 2 projects and 2 contents in a 10 word sentence. I didnt try to fix it.

[schae234]

@micke001 Thanks, reading that again, hurt my brain! I fleshed it out a little bit.