Placement of Legend is not optimal in UG

[nus-pe-bot]

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

---

No mention of legend in earlier sections. Readers would be unaware that there is a Legend for formatting things like price of which they would only realise after clicking on the hyperlink. This is especially so since having abbreviations for prices are counter-intuitive. Furthermore, the legend is a key element in the usage of functions yet it was not specified earlier and instead left as a Note block instead which would highly likely result in confusion on its usage. Labels such as [Price Category] would instead have been more comprehensive and intuitive for readers and users alike.

Here is an example text:

Generate a date itinerary, based on preferred location and budget: itinerary
Generates out a date itinerary, consisting of 2 restaurants and 2 activities from our curated collection. The
itinerary selected will be based off the user’s indicated location and budget.
Format: itinerary [LOCATION], [PRICE]
Note: The location and price must be within the legend. Ensure the formatting is strictly followed,
including the spacing and the capitalisation for location and price. For example, ``itinerary E, A will be
registered, whereas itinerary E,A or itinerary e, a will result in an error. Example of usage:
itinerary E, A`
Expected outcome:
Here is a rough itinerary for your date:
We begin with lunch at Five Oars, followed by some fun at Changi Museum Visit.
We proceed to have dinner at Missus, and finish the night at Punggol Promenade Nature Walk.
Are you satisfied with the itinerary? [Yes/No]
If user input no : Application will prompt user to initiate the generation process again if they wish to try
for another option.
Expected outcome:
We apologise! Perhaps you could try again?
If user input yes : Choice will be confirmed and saved in view history for ease of reference.
Expected outcome:
That's great! Enjoy your date!

---

_{[original: nus-cs2113-AY2324S2/pe-interim#2269] [original labels: type.DocumentationBug severity.VeryLow]}

[soongensayo]

Team's Response

We do agree that the convenience factor would be increased if there was a dedicated link to the Legend section at the start. However, we did include the hyperlink for all commands requiring the legend which we feel is sufficient for the usability of the user guide. Since this suggestion is valid for improvement in future revisions of the user guide, we decided to mark it as NotInScope.

Additionally, the visibility of the user guide is greatly improved when using pdf readers like Adobe Acrobat or Google Chrome, as detailed in another reply regarding a similar issue.

Duplicate status (if any):

--