Jump to content
bfarber
 Share


Easier Documentation Search

IPS is constantly looking for ways to improve, and one area of focus is documentation. We get a lot of feedback regarding documentation, and quite frequently the feedback we receive is, unfortunately, too vague to act on specifically. It's always a pleasant delight to get specific, focused feedback on how we can improve.

Last week I happened across a topic on our forums with just this kind of feedback, and after reviewing the suggestion and what it would take to implement, we agreed that the work was worth it. Cap'n Refsmmat posted some well-thought-out, clear and concise feedback on a specific action we could take that would make finding documentation easier, and I'm happy to announce that this change has been put in place on our website.

It was pointed out that as a user, it doesn't matter too much where the documentation you are searching for is located specifically. Whether it is a community article, official documentation, or an error code - you just want to find out more information, regardless of where that information is located. Today I built a few Sphinx search indexes of our downloads area, our error codes database, our official documentation, and our community-submitted articles, and then built a search interface to query all of these areas at once. We have replaced the search form in our documentation area with this new search utility.

Feel free to test out the new search tool and let us know what you think! Just head on over to our documentation page and use the search box at the top of the page to look for whatever it is you need to find. We may evolve this new tool further in the future, but for now we hope that it helps you find what you are looking for with less hassle and bouncing around.

 Share

Comments

Recommended Comments

[quote name='.Ian' date='27 July 2010 - 04:43 PM']
All we need now is a link to that area from the forums ;)

You're obviously one of those people who likes to have their cake and eat it too... :lol:

Yeah okay, you're right, that is something we need.

Link to comment
Share on other sites

Thats good. Although I do not think I have had issues with the docs. At least it is better then wordpress's docs OMGness those docs are awefull.

Any way good job and keep up the good work.

Link to comment
Share on other sites

[quote name='Wolfie' date='27 July 2010 - 10:45 PM']
You're obviously one of those people who likes to have their cake and eat it too... :lol:

Yeah okay, you're right, that is something we need.

hehe - we used to have links here on the forum to the customer area and main site, but they have been gone for a while now. :(

Link to comment
Share on other sites

[quote name='.Ian' date='28 July 2010 - 08:28 PM']
hehe - we used to have links here on the forum to the customer area and main site, but they have been gone for a while now. :(

Using CleanCut then I take it? The default skin still has the menu bar at the top of the page.

Link to comment
Share on other sites

[quote name='RobertMidd' date='29 July 2010 - 08:06 AM']
There is no pagination on the search results, is this intentional ?


Yes - that adds a level of complexity not really needed in this situation.

Link to comment
Share on other sites

As I'm working on upgrading my forum to 3.1.x, I just wanted to thank Invision for putting this new Documentation search together. It seems to work well and I've been able to find the information I've needed in the last few days. :)

..Al

Link to comment
Share on other sites



Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.

Guest
Add a comment...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

Loading...

×
×
  • Create New...