In testing, one of the comments was:

There is frequently a disconnect between generic information and information specific to the Farmers Market scenario. I think it is important for the task topics that have specific steps and screenshots in them all relate to the scenario with very specific instructions. Phrases like "Find the menu you wish to edit" are not as helpful as something like "Choose the Main navigation menu and click Edit Menu".

So, we need to go through the guide and identify topics that need updates for this, and make sure issues have been created.

Issues that I am already aware of, that address this for a few topics:
- language-content - #2711103: Content edit: language-content-config.txt
- config-uninstall - #2710969: Content edit: Fix up the Basic Configuration chapter

A second, somewhat related comment from testing:

Many of the topics are missing a "Go and observe the results of what you did" step. It helps reinforce the learning if we get a chance to do this.

So, we need to audit the task topics for this as well.

Probably this audit should be postponed until the rest of the testing issues have been created (some of them may address other topics in this regard). As of when this issue is being created, testing issues have been created through the Multilingual Configuration chapter (chapter 5).

Comments

jhodgdon created an issue. See original summary.

jhodgdon’s picture

Title: Content audit: Make sure task topics give specific/scenario-related, not generic instructions » Content audit: Make sure task topics give specific/scenario-related, not generic instructions, and end properly
Issue summary: View changes

One other thing to check for in task topics: At the end there should usually be a "go see what the result is" step, if possible. Adding to summary.

jhodgdon’s picture

Status: Postponed » Fixed

I did this content audit today, since all of the testing feedback issues have been created (and most have actually been fixed at this point). I looked at all the task topics to verify that:
- They have specific instructions
- The instructions are scenario-related
- At the end, it shows you the result of what you did

I filed one issue #2745133: Content Edit: Add final "see what you did" to a few topics, and marked a few existing Content Edit issues as being related to this audit. So, this issue can be considered Fixed, as the audit is done.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.