-
Notifications
You must be signed in to change notification settings - Fork 12
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
FAQ vs 101 vs Quick reference #178
Comments
@matuskalas @hansioan how about "Quick start guide" ? or "Quick start guide / FAQ" ? or "Quick reference / FAQ" ? |
from discussion with @hansioan, easy thing is just to add "Quick start guide" |
Added in 3.3.0: cc @hansioan |
nudge-nudge @hansioan - see comment above re term and definition. |
@joncison I've changed the definition in the Curation guidelines |
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
The text was updated successfully, but these errors were encountered: