WebHelp and Search Engine Optimization

This forum is for all Flare issues related to the HTML5, WebHelp, WebHelp Plus, and Adobe Air Targets
sdcinvan
Propellus Maximus
Posts: 1260
Joined: Wed Aug 21, 2013 11:46 am
Location: Vancouver, Canada

Re: WebHelp and Search Engine Optimization

Post by sdcinvan »

jbrock wrote:Thank you, Shawn. We recently rebuilt our support docs site. This time around, I used Bootstrap to build our masterpages. The modal with the email thingy is using Bootstrap + Feedburner. Feedburner basically takes the RSS feed from our changelog and sends an email to folks whenever it's updated.

You can play around with a sample project using this method. Download it at flarestrap.com. I haven't had a lot of time to post guides and updates to the project, but I would certainly love any feedback.

Thanks again!
Bootstrap is definitely on my reading/research list, after watching your very insightful MadCap webinar, "Project Showcase: Bomgar Improves SEO with a New Approach to WebHelp Targets": http://www.madcapsoftware.com/demos/pla ... ec9915581d

Thank you
Shawn in Vancouver, Canada
Main tools used: Flare 11.x, InDesign, Google Docs, Lectora, Captivate.
Report bugs: https://www.madcapsoftware.com/feedback/bugs.aspx ▪ Feature requests: https://www.madcapsoftware.com/feedback ... quest.aspx[/i]
jbrock
Propeller Head
Posts: 47
Joined: Tue Jul 13, 2010 12:20 pm
Location: 39047
Contact:

Re: WebHelp and Search Engine Optimization

Post by jbrock »

Everybody interested in SEO for Flare needs to check out the Top Navigation outputs in Flare 11. They do not use the Frame. And it appears the template they provide uses Foundation Framework. Head over to the Building Blocks section to see what's possible there.
Justin Brock
SEO Strategist at Bomgar
(former Technical Writer)

Flarestrap | Madcap Flare SEO
My Madcap Flare site
Twitter
LinkedIn
sdcinvan
Propellus Maximus
Posts: 1260
Joined: Wed Aug 21, 2013 11:46 am
Location: Vancouver, Canada

Re: WebHelp and Search Engine Optimization

Post by sdcinvan »

jbrock wrote:Everybody interested in SEO for Flare needs to check out the Top Navigation outputs in Flare 11. They do not use the Frame. And it appears the template they provide uses Foundation Framework. Head over to the Building Blocks section to see what's possible there.
Thank you again, Justin.

It seems a shame that forum user ratings are based upon total number of posts, rather than true merit. You are definitely NOT a junior propeller head. :lol:
Shawn in Vancouver, Canada
Main tools used: Flare 11.x, InDesign, Google Docs, Lectora, Captivate.
Report bugs: https://www.madcapsoftware.com/feedback/bugs.aspx ▪ Feature requests: https://www.madcapsoftware.com/feedback ... quest.aspx[/i]
jbrock
Propeller Head
Posts: 47
Joined: Tue Jul 13, 2010 12:20 pm
Location: 39047
Contact:

Re: WebHelp and Search Engine Optimization

Post by jbrock »

sdcinvan wrote:You are definitely NOT a junior propeller head. :lol:
That's so nice. Thank you!
Justin Brock
SEO Strategist at Bomgar
(former Technical Writer)

Flarestrap | Madcap Flare SEO
My Madcap Flare site
Twitter
LinkedIn
rob hollinger
Propellus Maximus
Posts: 661
Joined: Mon Mar 17, 2008 8:40 am

Re: WebHelp and Search Engine Optimization

Post by rob hollinger »

We Agree.
Looking at the "Rank" Structure some changes have been made.

- Jr. Propeller Head 0
- Propeller Head 10
- Sr. Propeller Head 100
- Propellus Maximus 500
- Senior Propellus Maximus 2000
- Master Propellus Maximus 5000
Rob Hollinger
MadCap Software
sdcinvan
Propellus Maximus
Posts: 1260
Joined: Wed Aug 21, 2013 11:46 am
Location: Vancouver, Canada

Re: WebHelp and Search Engine Optimization

Post by sdcinvan »

jbrock wrote:
sdcinvan wrote:You are definitely NOT a junior propeller head. :lol:
That's so nice. Thank you!

I think I just got you promoted. LOL

Thanks Rob but merit is still based on number of posts. Have you consider implementing the "Like" button feature and tied likes into rank?

Ah... no worries, IMHO rank is pretty unimportant. Anyone who has spent any amount of time in this forum, quickly realizes who's who. Actually, everyone is awesome (and I don't mean that in a PC way).
Shawn in Vancouver, Canada
Main tools used: Flare 11.x, InDesign, Google Docs, Lectora, Captivate.
Report bugs: https://www.madcapsoftware.com/feedback/bugs.aspx ▪ Feature requests: https://www.madcapsoftware.com/feedback ... quest.aspx[/i]
Rona Kwestel
Sr. Propeller Head
Posts: 212
Joined: Wed Apr 04, 2007 11:50 am

Re: WebHelp and Search Engine Optimization

Post by Rona Kwestel »

Justin, I've read through this thread carefully, and have started working my way through your presentation here: http://assets.madcapsoftware.com/webina ... vesSEO.pdf. However, before we consider going down the path of switching from tri-pane to top navigation, I want to be sure we’ve tried everything we can to improve the SEO with our current output.

I generated the Sitemap.xml file for our HTML5 KB using Flare, and while it covers every topic (though also includes extraneous content like thumbnail .png files which I’d just as soon leave out), it seems that many of our htm pages are not getting crawled even though they’re in the sitemap. Our site URL is http://bigdatakb.syncsort.com/, and if I do a Flare search within the site for “dmexpress machine nodename”, for example, the first hit is the link to the matching article, but if I do a google search on that same string, I get nothing. On the other hand, if I do a google search on “dmexpress platform compatibility”, the first hit is a link to the article in our KB on that topic. I cannot make heads or tails on why one topic is found and another is not.

One thing to be aware of, which may or may not be further complicating things, is that we enabled HTML5 server-based output to allow for our “attached files” such as pdf and text files to also be searched. This was more difficult to set up than we expected, and it didn’t quite work as advertised without some fiddling, so we had to manually copy those non-XHTML files from the Content\Resources\Attachments folder to the AutoSearch folder in order for them to be found in a Flare search. I disallowed the AutoSearch folder in Robots.txt so that the same content isn’t crawled in two different locations for google searches. Interestingly, those pdf files are more likely to be found in a google search than the htm topics that link to them. For example, I created a Google custom search (https://cse.google.com/cse/publicurl?cx ... otdtpa00f8) limited to just our site, and if I search on “implementation best practices”, I get the pdf doc attached to the topic with those words in the title, but the topic itself does not show up.

I uploaded a Robots.txt file to our site just this past Monday, and it does point to the Sitemap.xml file, but perhaps the site hasn’t been crawled since then. Based on your input, I tried pointing an external sitemap generator to our site URL to see what it would find, and it generated a sitemap with exactly two entries, one with the URL of the site, and one to the Default.htm file, so perhaps that’s a hint that there is some crawling issue. I’m not sure what is supposed to be in the root directory that would help the sitemap generator know which subdirectories to crawl, but clearly it wasn’t seeing any of our content. One suggestion was to create a topic containing a TOC proxy, and then somehow getting Google to crawl that topic file, but this feels like too much of a hack to me. I’m not sure how to get Google to crawl this topic any more than I can get it to find my Sitemap, and the topic itself is ugly and extraneous, as there is no clear way that I can see to style it without affecting the style of my actual TOC in the navigation pane.

I’m trying to understand why the top navigation is less problematic in terms of SEO, given that Google does seem able to see some iframe topics. One of the things that I don’t like about the top navigation is the less clear view to the user of where in the hierarchy of topics they are. Even if you use breadcrumbs, you only see the direct path to where you are, not what else surrounds it, so you still have no context. I found one site that seems to have the left-pane navigation that I prefer, but without the use of iframes. Check out http://www.cloudera.com/documentation/m ... ction.html. I don’t know if they used Flare or some other tool to build their doc site, but if we could achieve that with Flare, that would be ideal.

In the meanwhile, I’d still love to know whether the combination of the Flare-generated Sitemap.xml and the newly uploaded Robots.txt files we have in place should trigger Google to crawl all the pages on our site and yield better search results, or if there is more that we need to do. Since you can’t tell when/whether your site has been fully crawled, it’s hard to know if changes that you’ve made haven’t made a difference, or simply haven’t been “tested” yet.

Thanks for any and all input.
RickD
Propeller Head
Posts: 38
Joined: Wed Apr 29, 2015 11:19 pm

SiteMap question

Post by RickD »

I have recently added a sitemap to my Flare 11 HTML 5 top nav output as well as the project contains just under a thousand knowledgebase articles that can only be accessed via report links and by searching in the knowledgebase portal - so it seems ideal to get a sitemap for these articles to make sure Google indexes all of them. My concern is that the sitemap includes every file in the output, including images and style sheets. Currently about 30% of the content is not ideal for the sitemap created by the HTML 5 target.

Is there any way to customize the sitemap so that it only includes what you want index, or to have it just use the URLs /files in a specific folder?
jbrock
Propeller Head
Posts: 47
Joined: Tue Jul 13, 2010 12:20 pm
Location: 39047
Contact:

Re: SiteMap question

Post by jbrock »

RickD wrote:My concern is that the sitemap includes every file in the output, including images and style sheets. Currently about 30% of the content is not ideal for the sitemap created by the HTML 5 target.

Is there any way to customize the sitemap so that it only includes what you want index, or to have it just use the URLs /files in a specific folder?
Great question. If you use the xml-sitemaps.com, you can easily filter out file types and folders from the sitemap. (CSS files are normally skipped over anyway.)

In the Narrow Indexed Pages section, you can
  • Exclude certain extensions extensions from the sitemap (jpg, png, mp4)
  • Add certain extensions directly into the sitemap without retrieving them from the server, allowing you to crawl the site faster (pdf, ppt)
  • Exclude URLs by string (any url that includes mcgeneratedpopups)
  • Add URLs by string without retrieving them from the server
  • Crawl URLs, but don't include them (you could use this to include URLs a page links without including the linking page)
You can see how we've set up ours in the attached image.
You do not have the required permissions to view the files attached to this post.
Justin Brock
SEO Strategist at Bomgar
(former Technical Writer)

Flarestrap | Madcap Flare SEO
My Madcap Flare site
Twitter
LinkedIn
RickD
Propeller Head
Posts: 38
Joined: Wed Apr 29, 2015 11:19 pm

Re: WebHelp and Search Engine Optimization

Post by RickD »

Many thanks for the reply. I will check out the xml sitemap generator. Will also look at the Flare target sitemap a bit more to see if there is any way to change how it's created.
westiechick
Jr. Propeller Head
Posts: 1
Joined: Tue Feb 10, 2009 6:35 pm

Re: WebHelp and Search Engine Optimization

Post by westiechick »

I know you did this forever ago, Justin, but I'm trying to implement exactly this. However, for the life of me I can't figure out how to include the snippet in the masterpage. You mention doing it via Javascript - any chance of seeing the script one would use? I've hunted high and low and found lots of scripts that describe how to include html in the body, eg. adding some text, but nothing about adding it like an include. Also, I wondered if anything needed to be removed from the snippet itself, such as the HTML, HEAD, BODY tags etc. I'm guessing that some tags would need to be removed from the snippet so it didn't conflict with the same tags in the masterpage? All this is because I'm redesigning our internal help to use top navigation, but some of the submenus are unavoidably large, so I figured a megamenu would be a nicer way of presenting them, rather than the usual vertical parent/child. Any help much appreciated :-)
jbrock wrote:So sorry for the delayed answer.

The menu at the top is a simply a Flare snippet. I simply followed the tutorial here - http://net.tutsplus.com/tutorials/html- ... down-menu/ - to create the dropdown, then turned it into a snippet and embedded it on my master pages. There's JavaScript required for the menu, but you don't have to add it to Flare's js files. You can just link to it separately in the <head> of your masterpage.
NorthEast
Master Propellus Maximus
Posts: 6426
Joined: Mon Mar 05, 2007 8:33 am

Re: WebHelp and Search Engine Optimization

Post by NorthEast »

You can just open a master page and Insert > Snippet, exactly as you would insert a snippet in a topic.
Post Reply