How to update help files

  • Articolo

Note

Manual authoring of XML-based help is very difficult. The PlatyPS module allows you to write help in Markdown and then convert it to XML-based help. This makes it much easier to write and maintain help. PlatyPS can also create the Updateable Help packages for you. For more information, see Create XML-based help using PlatyPS.

There are many reasons to update help files, such as correcting errors, clarifying a concept, answering a frequently asked question, adding new files, or adding new and better examples.

To update a help file:

  1. Change the files.
  2. Translate the files into other UI cultures.
  3. Collect all help files (new, changed, and unchanged) for the module in each UI culture.
  4. Validate the files against the XML schema.
  5. Rebuild the CAB files for each UI culture.
  6. In the HelpInfo XML file, increment the version numbers of the CAB file for each UI culture.
  7. Upload the new CAB files to the location that's specified by the value of the HelpContentUri element in the HelpInfo XML file. Replace the older CAB files with the new CAB files.
  8. Upload the updated HelpInfo XML file to the location that's specified by the HelpInfoUri key in the module manifest. Replace the older HelpInfo XML file with the new file.