Platform-Knowledge-Base/_templates/faqs.md

title	description	type	page_title	slug	position	tags	teampulseid	ticketid	pitsid
Must contain "FAQs". Character Limit 255 Recommendation is to have <= 75 characters for a title as this can impact indexing by search engines like Google Bing etc. The article title should be a combination of the main problem statement and if applicable the key environment statement. Also determines the title in the table of contents.	Character Limit 255 Recommended length <= 155 characters. The description is what search engines usually show in the search results. Typically search engines truncate the description after the 155th character. The description should be a brief overview of the how-to article. It should exclude unnecessary phrases like "This article contains ..."	faq	Text that will populate the HTML file’s head:title attribute. Must contain "FAQs". It is good to use different than the title name here in order to cover more key words and be more discoverable via searches.	Unique identifier of the article. Used for cross-referencing. Ex faq-cloud-code-users	Keep this field blank for now!!! Integer specifying the display position of the article in the navigation. If omitted the articles are ordered alphabetically based on file name	Relevant keywords. A list of the available KB tags is available in the tags.md file under _templates. Separate multiple tags with commas. Currently not used but always fill in for future proofness.	A number representing the TeamPulse ID of the issue\question. Leave this blank if the issue\question doesn't exist as an item in TeamPulse	A number representing the ticket ID associated with this issue\question. The field can contain more than one ticket IDs (e.g. several clients have reported it). In such cases we separate the ticket IDs with commas. Leave this blank if the issue\question is not related to a support case	A number representing the public issue tracker ID associated with the issue\question. Leave this blank for now as PITS is not developed yet

Environment

Service	am-ad {{site.ab-s}} ({{site.ab}}), {{site.sb-s}}, {{site.am-ad}} ({{site.am}}), {{site.bs-d}} ({{site.bs}}), {{site.bs-u}}, {{site.bs-n}}, {{site.bs-bl}}, {{site.eq-s}}, {{site.af-s}}, Samples, {{site.tp}} General, Third-party product
Feature	[specify explicitly]
Plugin(s)	[specify explicitly]
Mobile development type	Hybrid ({{site.ac}} app), Native ({{site.ns}} app)
{{site.ab-s}} ({{site.ab}}) client	{{site.ab-web}}, {{site.ab-vse}}, {{site.ab-proton}}, {{site.ab-win}}, {{site.ab-cli}}, {{site.ab-sp}}
Mobile OS	iOS, Android, Windows Phone 8
Mobile OS version	[specify explicitly]
{{site.bs}} area	JavaScript SDK (Hybrid app), JavaScript SDK (Web app), JavaScript SDK (Cloud Code), .NET SDK (Web app), Native iOS app, Native Android app, Native Windows Phone app
{{site.ac}}\{{site.ns}} framework version	[specify explicitly]
Browser	[specify explicitly]
Browser version	[specify explicitly]
.NET framework version	[specify explicitly]
{{site.mvs}} version	[specify explicitly]

Introduction

Summarize the topic to which the FAQs are relating. One or two sentences are enough.

End the section with an article table of contents (TOC):

• FAQ 1?
• FAQ 2?
• FAQ 3?

FAQ 1?

Write the section name as a question. Put yourself in the shoes of the user when composing the sentence. Use as many keywords as possible while still keeping the sentence organic. When multiple keyword choices are available, try and include the spare ones in the answer to aid SEO.

In the section body, answer the question. Get straight to it, do not make introductions. If the question can be answered with yes or no, do it. Continue with a sentence containing more information.

If the answer features instructions, do the following:

• For short instructions, keep them in the FAQ.
• For long instructions, create a How-to article with them and link it from the FAQ or link to existing documentation.

FAQ 2?

FAQ 3?