writing guides.Additionally, we refer to
linguistic resourcesas a
Acrolinx Reuse is a powerful tool for maintaining consistent authoring standards and eliminating redundancy in documentation projects. Acrolinx Reuse uses linguistic analysis to match sentences based on meaning.
Text from content repositories or translation memories is automatically analyzed to produce small groups of sentences with similar meaning. The preferred wording can be easily validated, selected, and released for reuse.
For example, the following variations of a sentence might appear in your documentation:
The following items come in your TopSpin shipment.
Your TopSpin shipment includes the following items.
Your TopSpin package is shipped with the following items.
You can choose one these sentences to be your standard sentence, and Acrolinx identifies the variations and proposes your chosen standard sentence.
When authors run a check in an Acrolinx plug-in, Acrolinx recognizes sentences with similar meanings. The author receives a suggestion with the preferred wording. All suggestions have been automatically validated by the system and released by the guidance administrator. The author can accept the suggestion with a single mouse click.
Intelligent Reuse Process
The Acrolinx Reuse module is a flexible tool which you can use for a variety of purposes, such as cleaning a translation memory, or identifying new terminology. The most common use for the Acrolinx Reuse is to analyze and check consistency in a set of documentation. The following illustration summarizes the steps and components that are involved in using Acrolinx Reuse .
Acrolinx recommends the following major steps when starting up a documentation consistency project with Acrolinx Reuse .
- Harvest Sentences: Extract sentences from product information and store them on the Acrolinx Server.
- Procedure Summary: Create a sentence bank to store sentences and run checks by using the Acrolinx plug-ins to harvest sentences from your documents. For more information, see the topic Harvesting Sentences .
- Create Repository: Create a repository of sentences which are grouped together based on structure and meaning. Unlike sentence banks, the sentences in a repository are grouped into clusters. When Acrolinx groups sentences together, a representative sentence is automatically selected for each cluster.
- Procedure Summary: Add harvested sentences or import sentences from a text file to a new repository.
Before You Start
To use the intelligent reuse you must have a license and appropriately configured privileges and guidance package.
Your server administrator must install a license that is configured with the Reuse module and assign you with a role that has the privileges in the Reuse section enabled.
To enable your changes for checking, you also need the privileges in the Guidance Settings section and the privilege Restart servers .
Ensure that your guidance package is configured for Reuse. When your guidance package is configured for reuse, the ReuseHarvesting writing guide is displayed on the language server page in the Dashboard. If the ReuseHarvesting writing guide is missing, contact your Acrolinx project consultant.