Documentation & Help
The online documentation and help system has multiple purposes:
- Provide simple step-by-step instructions for the tasks you do everyday
- Shows you detailed information on how the system works
- Allows you to find answers and examples by searching the "knowledge base".
- Available anytime while you are using finerbutcher.com
This documentation tries to be driven by Tasks instead of features. After you learn the basic steps to get an animal from Order to Tag to Invoice, you can explore the other features that will help automate your business.
Manuals, Chapters & Articles
The online documentation is written using three main components:
- Manuals
- Chapters
- Articles
A manual is a collection of Chapters with a common theme, like "User Guide".
A Chapter is a collection of Articles with a common theme, like "Scheduling an Animal".
An Article is a specific set of steps or information that is usually focused on performing a single Task.
How we made our online documentation
We used a software tool designed to easily capture screen shots and produce step by step instructions for the tasks you will be doing.
Only the important part of the screen is captured to help you zoom in on the where you will be viewing/changing/printing/clicking etc.
To help you through each task, we used these three icons so you know when to Type, Click or use the Tab key. The TAB key is how you move from field to field in a Web application (not the Enter key).
How do I access Help when using Finerbutcher.com ?
There are three ways to access Help while using finerbutcher.com:
- Click on the " ? " icon in the navigation bar to see help about that screen (i.e Order List)
- Type your request in the Global Search on the Navigation Bar and click the magnifying + glass.
- Click a "? " button on a modal or panel screens where you are working (i.e. Update Hang Weights).
Help Breadcrumbs
There are several Manuals because putting everything in one would be just too much. As you explore the Help system, you will see a "locator" or "breadcrumb trail" above the Articles, like below.
On the upper left side of the screen you will see the other Chapters in the Manual your viewing.
Click the + sign (or the number on the right) to expand the Chapter and see the Articles.
Click the - sign to collapse the Chapter.
Keywords
Along the left side of the screen are numerous "keywords", sometimes called "tags". You probably have seen these on various websites to help you find information that interests you.
As each Article is written, it is assigned keywords. Notice the keyword "appointment" has been given to 3 Articles.
If you clicked on "appointment" you would see ALL three Articles !
Search Help
You can search the Help system for anything. Your search will:
- Find any Articles that have a keyword that matches what you typed
- Find any Article that has what you typed in the text
Here is an example of an Article that has the keyword "appointment" AND has the word "appointment" in the text !
Search Filter
You can filter which Manuals you want to see in your Search Results.
Simply check ( or uncheck ) the Manual names to see more (or less) Articles in your Search Result.
Print an Article
The documentation is likely to be revised as new users ask questions and features are added. You can print any Article at any time by simply clicking "Print Article".