Abundant Mechanical Writing: Advance File Searches
OVERVIEW
Searches in User Documents (manuals, etc.) generally fail as the Reader uses altered text for a idea than the author uses. Because the Reader’s text accomplish not arise in the file, the file search mechanism cannot acquisition them, resulting in frustration. This article describes a User-friendly method for improving searches, without having to chicken feed the Users’ behaviour or the search software.
YOUR READERS’ Text
Bodies employ the text that they understand when they say, address, or search. It’s folly to best shot to arm the Reader to employ the writer’s language; the Reader simply might not understand the “proper” word. Forced to employ alien text, the Reader will acquisition the User File to be aloof, or at least hard to employ.
For archetype, a User Book for a chat processing programme will probably employ the chat “formatting” when dealing with appearance fonts and amount, too as sheet arrangement. However suppose that your Reader uses the chat “appearance” to consult these topics. How can we amuse the search mechanism to supply the right aftereffect provided the Reader searches for “appearance”?
THE Mechanical Return: A THESAURUS SEARCH
The mechanical idea would be to transform the file search software from life an “exact word” search to a “Thesaurus Search.” In a Thesaurus Search, the User enters a chat that he/she knows, and the search returns synonyms or references to the synonyms in the file. Thus a properly locate up Thesaurus Search should give back references to “formatting” provided the Reader searches for “appearance.”
Unfortunately, the Thesaurus Search is seldom available, and creating one would crave changes to the existing search programme. A low tech idea may be the top return.
THE Return: SYNONYMS
For this method, you charge to lay synonyms of the author’s chat (”formatting”) on the pages that you desire the search to acquisition. Such synonyms may comprehend “appearance,” “architecture,” and “arrangement.” This is a child’s play, able idea.
You can acquisition take synonyms by using the thesaurus that is a component of most chat processors and of abounding libraries. Take the synonyms that your Readers are possible to employ. “Possible to employ” is based on your discussion of your Reader.
This leads us to the abutting catechism: How accomplish you lay the synonyms on the sheet?
DON’T Employ Abstruse Content
Technically savvy writers may buzz “why not employ abstruse content for the synonyms?” The help is that abstruse content will not “clutter up” the sheet.
So, provided in the sections of the User File where “formatting” is presented, the writer lay the chat “appearance” as abstruse content (assuming the search service would acquisition this abstruse advice), then the next will happen:
1. The Reader searches for “appearance.”
2. The search takes the Reader to the “formatting” cut of the file.
3. The Reader wonders “How did I amuse here?” The chat that he/she searched for (”appearance”) does not arise on the sheet, because it is abstruse.
Accustomed that a ambition of a User File is to reply the Reader’s questions, then doing anything that causes him/her to buzz another catechism (”How did I amuse here?”) is counter-productive. Abstruse synonyms are not the top return.
THE Pretty Idea: “YOU MAY Understand THIS AS…”
Hiding the synonyms is not a acceptable abstraction. It’s bigger to let the Reader understand what’s going on. The easiest action is to add a border of content on the sheet where the topic appears. This border of content begins with the phrase, “You may understand this as…”
To abide our “formatting” archetype, our explanatory synonym phrase becomes, “You may understand this as appearance, arrangement, or architecture.” A search for “appearance” brings the Reader to the “Formatting” cut.
Upon seeing the phrase “You may understand this as appearance, arrangement, or architecture,” the Reader knows why the search begin this point. The search satisfied the Reader, and did not add uncertainty to the bearings.
THE Backside Border
The ambition of all acceptable User Documents is to advance the Reader’s familiarity with the product. By using synonyms for “mechanical” terms, the writer makes the Reader’s file searches added able, because the needed topics will be begin using the Reader’s text.
By not hiding the synonyms, the Reader is not abashed as to why he/she arrived at that put in the file. The aftereffect is a bigger familiarity with the file and the product.