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

Introduce FAQPage as subtype (sibling?) of QAPage, for "Frequently asked questions" #1723

Open
danbri opened this Issue Aug 23, 2017 · 18 comments

Comments

Projects
None yet
@danbri
Contributor

danbri commented Aug 23, 2017

Context: when we did the Q/A design a few years ago (/cc @scor) we included a "QAPage" construct, to capture the idea that there are pages which carry collections of questions and answers. In retrospect I wasn't sure that it was a great idea, but the type is there.

Talking with colleagues at Google, we are interested to have schema that distinguishes "Frequently asked questions" content on the Web. Often these are several Q/A pairs to a page, sometimes organized into categories. Other times they are published one page per question.

We think "about" or "keywords" properties could handle the categorization aspect, and that perhaps the itemref construct might be useful to avoid duplication/verbosity when using Microdata and when all the items in one category have the same keywords. As an aside, perhaps in future "categories", "keywords" could be considered as subproperty of "about" and their structure/definition converged.

Proposal:

Add a new type FAQPage as a subtype [edit: or sibling] of QAPage, definition:

A [[FAQPage]] is a [[QAPage]] presenting one or more "Frequently asked questions".

We would add examples for a single page with a single question, and for a larger page with several questions, including categories handled via "about" and/or "keywords" properties on the QAPage and/or the Question (assuming that Answers rarely get dedicated metadata for such things).

Pinging @scor @tmarshbing @nicolastorzec @vholland @rvguha @tilid for perspectives

@danbri

This comment has been minimized.

Show comment
Hide comment
@danbri
Contributor

danbri commented Aug 23, 2017

@rvguha

This comment has been minimized.

Show comment
Hide comment
@rvguha

rvguha Aug 23, 2017

Contributor

Looks good to me.

guha

Contributor

rvguha commented Aug 23, 2017

Looks good to me.

guha

@vholland

This comment has been minimized.

Show comment
Hide comment
@vholland

vholland Aug 23, 2017

Contributor

Looks good to me

Contributor

vholland commented Aug 23, 2017

Looks good to me

@nicolastorzec

This comment has been minimized.

Show comment
Hide comment
@nicolastorzec

nicolastorzec Aug 23, 2017

Contributor

I like the idea of having FAQs but I don't see the benefit of making it a subclass of QAPage.

  • A QA page from a web portal like Quora, Yahoo Answer, or StackExchange is typically about one question and its answer(s) from one (or more) user(s).

  • A FAQ page is typically a collection of curated <question, answer> pairs, potentially organized into topical sections: i.e. multiple sections/topics per FAQ, multiple questions per section/topic, one official answer per question, one curator, etc.

FAQPage and QAPage should just be siblings.

Contributor

nicolastorzec commented Aug 23, 2017

I like the idea of having FAQs but I don't see the benefit of making it a subclass of QAPage.

  • A QA page from a web portal like Quora, Yahoo Answer, or StackExchange is typically about one question and its answer(s) from one (or more) user(s).

  • A FAQ page is typically a collection of curated <question, answer> pairs, potentially organized into topical sections: i.e. multiple sections/topics per FAQ, multiple questions per section/topic, one official answer per question, one curator, etc.

FAQPage and QAPage should just be siblings.

@emekaokoye

This comment has been minimized.

Show comment
Hide comment
@emekaokoye

emekaokoye Aug 24, 2017

FAQPage is a very good idea.

But let FAQPage be a subclass of schema:webpage while QAPage be a subclass of FAQPage.

Why?

Simply because QAPage represents a schema:webpage with multiple answers and FAQPage represents one of the following:

  1. Schema:webpage with 1 question and N answers.
  2. Schema:webpage with N questions and N answers.
  3. Schema:webpage with 1 question and 1 answer.
  4. Schema:webpage with N questions and 0 answers but questions are linked to #3.

emekaokoye commented Aug 24, 2017

FAQPage is a very good idea.

But let FAQPage be a subclass of schema:webpage while QAPage be a subclass of FAQPage.

Why?

Simply because QAPage represents a schema:webpage with multiple answers and FAQPage represents one of the following:

  1. Schema:webpage with 1 question and N answers.
  2. Schema:webpage with N questions and N answers.
  3. Schema:webpage with 1 question and 1 answer.
  4. Schema:webpage with N questions and 0 answers but questions are linked to #3.
@MrJonPayne

This comment has been minimized.

Show comment
Hide comment
@MrJonPayne

MrJonPayne Aug 24, 2017

I'd be careful about the 'keywords' & 'category' properties. You will likely find a lot of excitable SEO chaps stuffing these with poor quality data in the mistaken belief that they will somehow achieve some sort of answer box nirvana on Google search results pages.

MrJonPayne commented Aug 24, 2017

I'd be careful about the 'keywords' & 'category' properties. You will likely find a lot of excitable SEO chaps stuffing these with poor quality data in the mistaken belief that they will somehow achieve some sort of answer box nirvana on Google search results pages.

@VladimirAlexiev

This comment has been minimized.

Show comment
Hide comment
@VladimirAlexiev

VladimirAlexiev Aug 24, 2017

  • isn't there a general mechanism to indicate preferredness, notability, or importance? If not, I think we need one.
    I'm thinking of cultural heritage, where it's important to indicate the preferred image and title of an artwork
  • @emekaokoye @nicolastorzec QAPage is defined as "focussed on a specific Question and its Answer(s)" while FAQPage is only about important questions, so indeed these would be siblings.
  • please change the issue title to say "subtype of QAPage" (now it says subtype of itself)

VladimirAlexiev commented Aug 24, 2017

  • isn't there a general mechanism to indicate preferredness, notability, or importance? If not, I think we need one.
    I'm thinking of cultural heritage, where it's important to indicate the preferred image and title of an artwork
  • @emekaokoye @nicolastorzec QAPage is defined as "focussed on a specific Question and its Answer(s)" while FAQPage is only about important questions, so indeed these would be siblings.
  • please change the issue title to say "subtype of QAPage" (now it says subtype of itself)

@danbri danbri changed the title from Introduce FAQPage as subtype of FAQPage, to indicate "Frequently asked question" pages to Introduce FAQPage as subtype (sibling?) of QAPage, for "Frequently asked questions" Aug 24, 2017

@danbri

This comment has been minimized.

Show comment
Hide comment
@danbri

danbri Aug 24, 2017

Contributor

@MrJonPayne indeed, a lot of people see 'keywords' as a kind of 1990s relic. But it may yet still have usecases when carefully used.

Contributor

danbri commented Aug 24, 2017

@MrJonPayne indeed, a lot of people see 'keywords' as a kind of 1990s relic. But it may yet still have usecases when carefully used.

@danbri

This comment has been minimized.

Show comment
Hide comment
@danbri

danbri Aug 24, 2017

Contributor

Ok, the point about sibling rather than subtype is sounding persuasive; I've amended the title here for now

Contributor

danbri commented Aug 24, 2017

Ok, the point about sibling rather than subtype is sounding persuasive; I've amended the title here for now

@Aaranged

This comment has been minimized.

Show comment
Hide comment
@Aaranged

Aaranged Aug 24, 2017

I like where this is going. In particular, I think planning to accommodate FAQs that consist of multiple question/answer pairs is critical, as this is probably the most common form of FAQ pages.

I would think it's obvious, but one of the things that this type should leverage is existing Question/question and Answer/answer vocabulary. ItemList may also have a place in being able to address those multiple Q/A pairs

Broadly agree that this makes more sense as a sibling than a subtype.

Aaranged commented Aug 24, 2017

I like where this is going. In particular, I think planning to accommodate FAQs that consist of multiple question/answer pairs is critical, as this is probably the most common form of FAQ pages.

I would think it's obvious, but one of the things that this type should leverage is existing Question/question and Answer/answer vocabulary. ItemList may also have a place in being able to address those multiple Q/A pairs

Broadly agree that this makes more sense as a sibling than a subtype.

@nicolastorzec

This comment has been minimized.

Show comment
Hide comment
@nicolastorzec

nicolastorzec Aug 24, 2017

Contributor

@VladimirAlexiev: I added some thoughts on preferredness/notability/importance on #1726

Contributor

nicolastorzec commented Aug 24, 2017

@VladimirAlexiev: I added some thoughts on preferredness/notability/importance on #1726

@kidehen

This comment has been minimized.

Show comment
Hide comment
@kidehen

kidehen commented Aug 24, 2017

@danbri ,

Here's our FAQ Ontology : http://www.openlinksw.com/ontology/faq# .

@jeannieh

This comment has been minimized.

Show comment
Hide comment
@jeannieh

jeannieh Aug 26, 2017

With Google Maps now offering a means to both ask and answer questions, this may possibly be confusing if it is made a subclass of QAPage. I too, agree with the thought about using a sibling.

jeannieh commented Aug 26, 2017

With Google Maps now offering a means to both ask and answer questions, this may possibly be confusing if it is made a subclass of QAPage. I too, agree with the thought about using a sibling.

danbri added a commit that referenced this issue Sep 1, 2017

danbri added a commit that referenced this issue Sep 1, 2017

danbri added a commit that referenced this issue Sep 1, 2017

@danbri

This comment has been minimized.

Show comment
Hide comment
@danbri

danbri Sep 1, 2017

Contributor

Ok, draft staged at http://pending.webschemas.org/FAQPage - please take a look

(Once we're happy let's cross-reference it back from QAPage too.)

Contributor

danbri commented Sep 1, 2017

Ok, draft staged at http://pending.webschemas.org/FAQPage - please take a look

(Once we're happy let's cross-reference it back from QAPage too.)

@danbri

This comment has been minimized.

Show comment
Hide comment
@danbri

danbri Sep 11, 2017

Contributor

Note that http://pending.schema.org/BackgroundNewsArticle also talks about FAQs. We should figure out how these relate.

Contributor

danbri commented Sep 11, 2017

Note that http://pending.schema.org/BackgroundNewsArticle also talks about FAQs. We should figure out how these relate.

@danbri

This comment has been minimized.

Show comment
Hide comment
@danbri

danbri Sep 11, 2017

Contributor

I wouldn't say FAQPage is a subtype of BackgroundNewsArticle as not all FAQs are news-related. But we should at least cross-link the definitions.

Contributor

danbri commented Sep 11, 2017

I wouldn't say FAQPage is a subtype of BackgroundNewsArticle as not all FAQs are news-related. But we should at least cross-link the definitions.

@danbri

This comment has been minimized.

Show comment
Hide comment
@danbri

danbri Nov 9, 2017

Contributor

Any final comments on this? It is on its way to be included in the pending section of our next release

Contributor

danbri commented Nov 9, 2017

Any final comments on this? It is on its way to be included in the pending section of our next release

@magico

This comment has been minimized.

Show comment
Hide comment
@magico

magico Nov 9, 2017

Looks good. Would it be useful to add a reference to schema.org/Question? Something along the lines of...

A FAQPage is a WebPage presenting one or more frequently asked Question (see also QAPage).

magico commented Nov 9, 2017

Looks good. Would it be useful to add a reference to schema.org/Question? Something along the lines of...

A FAQPage is a WebPage presenting one or more frequently asked Question (see also QAPage).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment