Best Practice: Knowledge article sections should have valid section names

 

What does this best practice check for?

MP elements have associated product knowledge that end-users use to decide how to address problems that occur in their environment. The knowledge article template shows that knowledge articles should have separate sections: Summary, Configuration, Causes, Resolutions, Additional Information, and External Resources. It is considered a best practice for knowledge articles to not contain any additional sections except for the aforementioned ones.

Why is it important to follow this best practice? What is the impact of not following this best practice?

The Operations Console is looking for specific section headings when it displays knowledge articles. While having extra sections in an MP that is running on a machine with an English locale will only result in inconsistency, and possibly customer confusion, the effect can be more drastic on a non-English locale machines. On globalized settings, knowledge articles with extra sections will not be correctly interpreted, and will not display correctly in the Operations Console.

How do I fix this in my MP?

Using the Authoring Console:

1.        When adding product knowledge for any MP element, it is not possible to deviate from the knowledge template, which contains the correct sections in the correct order. It is also not possible to add sections to this template.

 

Using XML:

       < KnowledgeArticle ElementID = " Microsoft.Windows.Server.2008.LogicalDisk.AvailabilityHealth" Visible =" true" >

         < MamlContent >

           < maml:section >

              < maml:title > Summary </ maml:title >

             < maml:para > The logical disk volume is not available. The data stored on the volume is inaccessible. </ maml:para >

           </ maml:section >

           < maml:section >

             < maml:title > Causes </ maml:title >

             < maml:para > A logical disk may become inaccessible due to a number of reasons some of which include: </ maml:para >

             < maml:list >

               < maml:listItem >

                 < maml:para > Related physical disk has been removed </ maml:para >

               </ maml:listItem >

                < maml:listItem >

                 < maml:para > Physical disk has become corrupt (for example; bad sectors) or inoperable </ maml:para >

               </ maml:listItem >

               < maml:listItem >

                 < maml:para > Problem with physical disk driver </ maml:para >

               </ maml:listItem >

             </ maml:list >

             < maml:para />

           </ maml:section >

           < maml:section >

              < maml:title > Resolutions </ maml:title >

             < maml:para > Check the status of your hardware for any failures (for example, a disk, controller, cabling failure). In most cases, the system log contains additional events from the lower-level storage drivers that indicate the cause of the failure. </ maml:para >

              < maml:para > After you have isolated and resolved the hardware problem: </ maml:para >

             < maml:para > 1.  Open the Disk Management snap-in. </ maml:para >

             < maml:para > 2.  Rescan the disks and then reactivate any disks with errors. </ maml:para >

             < maml:para > Resynchronize or regenerate the volume as necessary if the disk was a member of a mirrored or RAID-5 volume. </ maml:para >

             < maml:para > 3.  Run chkdsk on any reactivated volumes. </ maml:para >

             < maml:para />

           </ maml:section >

         </ MamlContent >

       </ KnowledgeArticle >