¶ Guidelines For “How-To” Article Structure
Always use this structure when creating a “How To” article in our wiki.
¶ Page Title
- Format:
How To [Task] In [System/Platform] - Example:
How To Edit Product Image In Kellanova PIM
¶ Tags
Always tag as “how-to”
¶ Always Include A Page Description
Always populate the page description field because this helps understand the purpose of the page when it shows up in search results
¶ Always Include This Content:
-
¶ Introduction
- Who Does This: Which role or team typically completes this task (e.g., “Content Author”, “Developer”).
- When Do They Do It: When and why the task is performed
- Which Platform: Specify if it applies to Engage 1, Engage 2, or other
- Prerequisite Knowledge:
- Programming Languages if relevant.
- Applications/Systems/Services (e.g., Kellanova PIM, AEM).
-
¶ Reference Info
- Link to relevant other Wiki reference pages like URLs or logins, if needed
-
¶ A List of Steps, For Each Step Include:
- Action: The specific thing a user does (e.g., “Click the ‘Save’ button”).
- Screenshot
- Gotchas: Common pitfalls, workarounds, or points of confusion.
-
¶ Optional: Additional Tips and Gotchas
- Only if necessary add any other tips and watch-outs
¶ Example
- How To Create A Wiki Page
- Intra-page content structure should show up like this where the steps are listed:
