search

bio-tools / biotoolsSchema

biotoolsSchema : Tool description data model for computational tools in life sciences
Creative Commons Attribution Share Alike 4.0 International
36 stars 12 forks source link

FAQ vs 101 vs Quick reference #178

Open matuskalas opened 4 years ago

matuskalas commented 4 years ago

FAQ (#132) is very specific, and I'm somewhat unsure if it is that widely used among bioinformatics tools these days (hint: attempt of an English understatement).

On the other hand, 101 or some kind of "Quick reference" are often the most useful kind of documentation for enabling a user to start using a tool. The full documentation a.k.a. reference manual is usually over the top and freaky scary in such case.

101s and quickrefs aren't used by all tools either, but they are growingly popular, especially among modern complex tools like workbenches etc.

So what about merging all these notions into 1 type of documentation link? With mentioning all these options in the info about it? The name could be 101 or Quick reference, or even 101 / FAQ or a better name if it pops up. CC @hmenager @jvanheld

joncison commented 4 years ago

@matuskalas @hansioan how about "Quick start guide" ? or "Quick start guide / FAQ" ? or "Quick reference / FAQ" ?

joncison commented 4 years ago

from discussion with @hansioan, easy thing is just to add "Quick start guide"

joncison commented 4 years ago

Added in 3.3.0: Quick start guide : "A short guide helping the end-user to use the software as soon as possible."

cc @hansioan

joncison commented 4 years ago

nudge-nudge @hansioan - see comment above re term and definition.

hansioan commented 4 years ago

@joncison I've changed the definition in the Curation guidelines