Draft FAQ Content type for HHS.gov

bonniestrong commented 9 years ago

Hi everyone,

I'm adding our draft FAQ content type for comments. We already use a FAQ content type in Percussion which creates an xml feed ingested by our Google Search Appliance. So when someone searches on a trigger word the FAQ Question and a 'short answer' appears directly on the SERP with a link to full FAQ page.

As we adapt this to a new Drupal content type, we are working through the following:

We have recommended lengths for Questions and 'Short' Answers, but not a strict character limit. Some of the questions folks wish to include can become prohibitively long and complex. So we hope to show them visually why the shorter question is more useful but allow them to let that sentence run on as long as necessary if there is truly no option. We could have gone the short question /long question route as we have done with titles and descriptions on Article, but we decided against it.
However, a 'short answer' is required. We want to encourage content authors to give quick answers upfront so that users know if the full FAQ is actually going to cover what they expect and / or if it can statisfy their goal without clicking through to the full FAQ.
We have a site-wide hhs FAQ section as well as numerous Staffdiv / topic specific FAQs. We'd like to change the field name 'type' but haven't settled on a replacement - perhaps FAQ Set. Each set will have their own 'category' taxonomy as the topic specific faqs can get very SME specific.
The Site-Wide FAQ, however, will conform to the same category taxonomy we use for Blogs and News Releases.
We use an 'Audience' taxonomy as well (which is site-wide) as our FAQs can be targeted to general consumers, SMEs, Researches, Policymakers, etc. and should be written accordingly.
We are considering adding an image field (which would not be required), but could be used for iconography or logos as well as images.
Like our Article content type we will add Twitter and OpenGraph markup. I've only listed the Schema.org markup here.
We identify the schema.org/question property in the markup header. However we aren't actually using any of the itemproperties from it (instead sticking with the basic name/text properties of CreativeWorks). Schema.org/question is tailored for Quora type q/a sites (that crowdsource answers and use upvoting for example). This is an area we've decided to keep simple for now and extend once we have more experience with Schema.org. If you have suggestions on this, let us know!

jpgsa commented 9 years ago

Thanks for posting Bonnie and the HHS team. I bet @philipashlock has some thoughts on this one. Phil?

BobRand commented 9 years ago

Bonnie,

I’m interested in how your search returns are triggered by specific FAQ words. Could you offer an example and link to the xml feed to see what that looks like?

Also, what does your Twitter and OpenGraph markup look like?

Thanks, Bob Rand, SEC

From: bonniestrong [mailto:notifications@github.com] Sent: Thursday, January 08, 2015 4:38 PM To: GSA/Open-And-Structured-Content-Models Subject: [Open-And-Structured-Content-Models] Draft FAQ Content type for HHS.gov (#11)

Hi everyone,

I'm adding our draft FAQ content type for comments. We already use a FAQ content type in Percussion which creates an xml feed ingested by our Google Search Appliance. So when someone searches on a trigger word the FAQ Question and a 'short answer' appears directly on the SERP with a link to the longer answer in the FAQ.

So we want to be sure we keep that kind of flexibility in our Drupal Content Type. Here are some of the issues we are still considering:

· We have recommended lengths for Questions and 'Short' Answers, but strict character limit. Some of the questions folks wish to include can become prohibitively long and complex. So we hope to show them visually why the shorter question is more useful but allow them to let that sentence run on as long as necessary if there is truly no option. We could have gone the short question /long question route as we have done with titles and descriptions on Article, but we decided against it.

· However, a 'short answer' is required. We want to encourage content authors to give quick answers upfront so that users know if the full FAQ is actually going to cover what they expect and / or if it can statisfy their goal without clicking through to the full FAQ.

· We have a site-wide hhs FAQ section as well as numerous Staffdiv / topic specific FAQs. We'd like to change the field name 'type' but haven't settled on a replacement - perhaps FAQ Set. Each set will have their own 'category' taxonomy as the topic specific faqs can get very SME specific.

· The Site-Wide FAQ, however, will conform to the same category taxonomy we use for Blogs and News Releases.

· We use an 'Audience' taxonomy as well (which is site-wide) as our FAQs can be targeted to general consumers, SMEs, Researches, Policymakers, etc. and should be written accordingly.

· We are considering adding an image field (which would not be required), but could be used for iconography or logos as well as images.

· Like our Article content type we will add Twitter and OpenGraph markup. I've only listed the Schema.org markup here.

· We identify the schema.org/question property in the markup header. However we aren't actually using any of the itemproperties from it (instead sticking with the basic name/text properties of CreativeWorks). Schema.org/question is tailored for Quora type q/a sites (that crowdsource answers and use upvoting for example). This is an area we've decided to keep simple for now and extend once we have more experience with Schema.org. If you have suggestions on this, let us know! [faq]https://cloud.githubusercontent.com/assets/9113785/5671294/a9cf1ffe-9754-11e4-8cbd-cc509de6ceb2.JPG

— Reply to this email directly or view it on GitHubhttps://github.com/GSA/Open-And-Structured-Content-Models/issues/11.

GSA / Open-And-Structured-Content-Models

Draft FAQ Content type for HHS.gov #11