Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

INDEX

Documentation Library

Search for information on Hornbill Documentation.

{{docApp.searchError}}

{{docApp.searchResultFilteredItems.length}} results for "{{docApp.currentResultsSearchText}}" in {{docApp.searchFilterBySpecificBookTitle}}

Have questions about this site?

What is this site?

  • This website is Hornbill's new product documentation website and is currently under development.
  • It is intended that all existing and future public-facing documentation we produce will be available to search, browse and share.
  • Hornbill's current documentation is available at Hornbill Wiki but over time this content will be migrated to this documentation site.
  • Please feel free to have a look around at any time.

Why has Hornbill created this site?

  • Hornbill's products have moved on considerably since we introduced it almost 10 years ago. At the time, the MediaWiki tool was sufficient, but we have outgrown it.
  • Our customers are more enterprise focused and more self-sufficient than ever before, so for 2023 and beyond we have established a new documentation platform and team to drive our documentation initiative forwards.
  • We are aiming to deprecate the use of Hornbill Wiki for most Hornbill related documentation.
  • We want to enable our growing partner network with product resources and information, documentation beyond our Wiki approach is required.
  • We could definitely do with some help, and may even pay for some! If you have domain knowledge and would like to help, please check out our Hornbill Docs Contributor Guide and contact the Hornbill docs team at docs@hornbill.com.

What will this site be good for?

  • Community contribution will be facilitated, encouraged, and most welcome.
  • High quality documentation, will be kept up to date as rapidly as our products evolve.
  • Real-time content search and discovery.
  • Articles organized into books, books into libraries, creating a more natural and logical structure to our documentation.
  • Legacy API documentation and various other documentation sources will all be consolidated into a single unified documentation system.
  • Documentation available in browser as well as printable/viewable as PDF on demand.
  • Personalized documentation experience, allowing dark/light mode, article subscriptions, social media sharing and other useful features.
  • Almost all publicly available documentation on docs.hornbill.com will be open-source and available to fork on GitHub, allowing customers to derive their own custom documentation around Hornbill products should they wish to.

What is the timeline for this site?

  • We have taken the decision to publish and make available early, there is very little content at this time.
  • As and when we have completed/usable documentation, it will be published here.
  • We have a host of additional features we wish to add over time, so please watch this space.
  • We expect most of our existing documentation should be reviewed/migrated to docs.hornbill.com over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Text Assist

A set of AI-driven tools for quick creation and manipulation of text content. Ask HAi to elaborate on a problem, suggest a solution, spell check and grammar check content, shorten, listify, or change the tone. These features are available anywhere you can post text or comments - accessible from a simple drop-down menu.

Text Assist

What you can do

  • Ask HAi - An open-ended prompt for getting how-to solutions to common issues - for example “How to set up an email signature in Outlook in Office 365”.
  • Change the tone of the text in the box to suit the audience:
    • Apologetic
    • Professional
    • Friendly
    • Technical
  • Improve Text - Correct spelling, and grammar, and improve readability/clarity.
  • Shorten Text - Remove unnecessary words.
  • Listify - Restructure the content in the box in list form rather than blocks of text.

Where you can use it

Text areas within Hornbill records:

  • Adding a post to a request timeline
  • Adding a documented resolution to a request
  • Writing an email update to the customer Bulk update requests from the request list view
  • Knowledge articles

Output format

Text Assist returns content in the format that the text area uses. For example, when updating a timeline or resolving a request, it will return Wiki Markup. When adding an email update or knowledge, it will output HTML.

Tips and Tricks

  1. Snippets - You can use snippets with request variables and the Ask HAi instruction to store custom prompts, one example is to use the following snippet for producing an initial response to a user’s request.
{{summary}}
{{description}}
Write 4 clarifying question to solve this issue.

Snippet Tip Snippet Response

  1. Highlighting text to use as a prompt - If you have a large body of text and want to add something using a prompt you can type the prompt out and highlight the text, once generated the response will overwrite the highlighted text instead of being appended to the end. The full body of text not highlighted when using the Ask HAi prompt is sent as additional context to enrich the response.

Context Tip

  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document