How to Correct the Documentation

Readers can report what is wrong, missing or unclear directly on the documentation in the aprity web portal. Corrections are sent to the next analysis, and the portal shows what that analysis did with each one.

Prerequisites

• Access to the aprity web portal (the aprity User or aprity Admin permission set).
• At least one published version of the documentation.

Comment on a business rule

1. Open an object page and go to its Rules & validations tab.
2. In the Business rule register, find the rule. Use the filter box or Group by if the list is long.
3. Click the comment icon at the end of the rule's row.
4. Choose the Feedback type:
   • Correction — the description is wrong;
   • Removal — the item should not be there;
   • Addition — something is missing;
   • Clarification — the wording is unclear;
   • Obsolete — the item no longer reflects the org.
5. Write your Comment (required). Describe what should change and cite the source if you can.
6. Optionally, click Suggest corrected text and write the text you would expect.
7. Click Send.

Comment on another part of a page

Hover over a block of content (an overview, a section, a process step…) and click the feedback icon that appears next to it, or use Feedback on the page in the page's feedback panel. The form is the same as above.

The Page feedback panel lists the feedback already written by your organization on the current documentation, with its status.

One active contribution per item

If someone has already contributed on the same item, the form tells you: your contribution replaces theirs, and theirs stays available in the history. There is a limit on active contributions per item; archive an older one to add a new one.

Follow what happened to your corrections

Open Human corrections in the Quality group of the portal's left navigation. Each correction shows who wrote it, when, and its state:

State	Meaning
Written	Recorded, not yet sent to an analysis.
Submitted for analysis	Sent to the analysis; the outcome is not determined.
Applied	Taken up by the analysis.
Not applied	Sent, but not taken up by the analysis.
Undetermined	The portal cannot tell what happened.

Corrections are not applied to a version that is already published: they take effect on the next analysis. Some remarks are recorded for review only and are not re-applied automatically; the form tells you when that is the case.

Administrators also see a Moderation tab, where they can Archive a correction or Mark as superseded.

Teach aprity your vocabulary

When the documentation stumbles on your internal acronyms or business terms, define them once instead of correcting every rule.

1. Open the account menu (your avatar, top right of the portal) and click Vocabulary.
2. Click Add a term, then fill in the term, its category and its definition.
3. Click Save.

The terms are sent to the next analysis so that it writes your words rather than guessing them. Saving a changed vocabulary makes the next analysis re-analyze your org's components so the new wording reaches the documentation.

Tips

• Be specific: name the field, rule or condition that is wrong.
• For a correction, say what the right information is.
• Report one issue per contribution.