{"id":24187,"date":"2024-06-12T13:30:30","date_gmt":"2024-06-12T11:30:30","guid":{"rendered":"https:\/\/docs.prim.io\/general-instructions-for-writing-help-pages\/"},"modified":"2024-06-12T13:30:30","modified_gmt":"2024-06-12T11:30:30","slug":"general-instructions-for-writing-help-pages","status":"publish","type":"page","link":"https:\/\/docs.prim.io\/en\/general-instructions-for-writing-help-pages\/","title":{"rendered":"General instructions for writing HELP pages"},"content":{"rendered":"

General conditions<\/h2>\n

Do not work alone! This is teamwork. Keep up with the team!<\/p><\/blockquote>\n

Write so that others understand what you have written. Describe each field well, because someone else or you won’t be able to find out what you are looking at or what the help is about!<\/p>\n

When describing a structure in the system use the symbol ” > “<\/strong> to describe the path to the interface – for example Finance > Finance Settings > Taxes<\/strong><\/p>\n

Creating a Helpdesk at AWF<\/h2>\n
    \n
  1. When you create a link you must fill in the Interface name<\/strong> field SMALL! So when someone looks at it after you to find out what the helpa is about!\n
      \n
    1. Wrong – Sale<\/li>\n
    2. Correct – P&S > Sales > New Sale<\/li>\n<\/ol>\n<\/li>\n
    3. When referencing a page, check that its ID(https:\/\/docs.prim.io\/bg\/?page_id=1507)<\/strong> no longer exists. If it exists check if it makes sense to create the link or if the existing link is not described well. Keep in mind that it is possible and meaningful for several different interfaces in the system to use a common help in WP!<\/li>\n<\/ol>\n

      Creating a Help in WordPress<\/h2>\n

      Every module in WP has a structure:<\/p>\n