{"id":8685,"date":"2015-02-04T06:00:00","date_gmt":"2015-02-04T14:00:00","guid":{"rendered":"http:\/\/www.sapien.com\/blog\/?p=8685"},"modified":"2015-02-20T09:17:20","modified_gmt":"2015-02-20T17:17:20","slug":"introducing-powershell-help-writer-2015","status":"publish","type":"post","link":"https:\/\/dev.sapien.com\/blog\/2015\/02\/04\/introducing-powershell-help-writer-2015\/","title":{"rendered":"Introducing PowerShell HelpWriter 2015"},"content":{"rendered":"<p>The help system in Windows PowerShell is well known and much loved. But, it has been very difficult to create XML help files that comply with the PSMAML schema that the Get-Help cmdlet requires.<\/p>\n<p>Until now.<\/p>\n<p>Introducing <strong><em>PowerShell HelpWriter<\/em><\/strong> by SAPIEN Technologies, Inc., the first professional, fully featured help authoring studio for Windows PowerShell help.<\/p>\n<p><em>PowerShell HelpWriter<\/em> saves you time and increases productivity &#8211; focusing your attention on writing help instead of struggling with the complex PSMAML schema.<\/p>\n<blockquote><p><a href=\"http:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2015\/02\/image.png\"><img loading=\"lazy\" decoding=\"async\" style=\"display: inline; border: 0px;\" title=\"image\" src=\"http:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2015\/02\/image_thumb.png\" alt=\"image\" width=\"623\" height=\"451\" border=\"0\" \/><\/a><\/p><\/blockquote>\n<p><strong><em>PowerShell HelpWriter <\/em><\/strong>creates help files from a module or from scratch.<\/p>\n<ul>\n<li>Fully-featured designer makes it easy to write accurate and complete help topics<\/li>\n<li>Generates help files for all commands in a module<\/li>\n<li>Creates new help topics from scratch and edits existing help files<\/li>\n<li>Works on all command types: cmdlets, functions, workflows, and CIM commands<\/li>\n<li>Converts comment-based help to Help XML files<\/li>\n<li>Lets you add and remove parameters as the code changes<\/li>\n<li>Includes a built-in XML editor<\/li>\n<li>Validates Help XML (PSMAML) files<\/li>\n<\/ul>\n<p>&nbsp;<\/p>\n<p><strong><em>PowerShell HelpWriter <\/em><\/strong>manages the details so you can concentrate on writing great help content.<\/p>\n<ul>\n<li>Create help files for any module \u2013 with any command types.<\/li>\n<\/ul>\n<blockquote><p><a href=\"http:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2015\/02\/image1.png\"><img loading=\"lazy\" decoding=\"async\" style=\"display: inline; border: 0px;\" title=\"image\" src=\"http:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2015\/02\/image_thumb1.png\" alt=\"image\" width=\"403\" height=\"314\" border=\"0\" \/><\/a><\/p><\/blockquote>\n<ul>\n<li><em>PowerShell HelpWriter<\/em>\u00a0names the files so <strong>Get Help<\/strong> can find them, even when you have multiple nested modules.<\/li>\n<\/ul>\n<blockquote><p><a href=\"http:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2015\/02\/image2.png\"><img loading=\"lazy\" decoding=\"async\" style=\"display: inline; border: 0px;\" title=\"image\" src=\"http:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2015\/02\/image_thumb2.png\" alt=\"image\" width=\"465\" height=\"138\" border=\"0\" \/><\/a><\/p><\/blockquote>\n<p>&nbsp;<\/p>\n<ul>\n<li>View and edit command syntax \u2013 you don&#8217;t need to write it.<\/li>\n<\/ul>\n<blockquote><p><em>PowerShell HelpWriter<\/em> adds the cmdlet attributes, parameters, parameter attributes,\u00a0and input and output types\u00a0to your file.<\/p><\/blockquote>\n<blockquote><p><a href=\"http:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2015\/02\/image3.png\"><img loading=\"lazy\" decoding=\"async\" style=\"display: inline; border: 0px;\" title=\"image\" src=\"http:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2015\/02\/image_thumb3.png\" alt=\"image\" width=\"553\" height=\"137\" border=\"0\" \/><\/a><\/p><\/blockquote>\n<ul>\n<li>Write and edit help for parameters<\/li>\n<\/ul>\n<blockquote><p><em>PowerShell HelpWriter <\/em>makes it easy to compose help descriptions. It lets you add and delete parameters to keep up with code changes. It even indicates when a parameter is dynamic.<\/p><\/blockquote>\n<blockquote><p><a href=\"http:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2015\/02\/image4.png\"><img loading=\"lazy\" decoding=\"async\" style=\"display: inline; border: 0px;\" title=\"image\" src=\"http:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2015\/02\/image_thumb4.png\" alt=\"image\" width=\"490\" height=\"300\" border=\"0\" \/><\/a><\/p><\/blockquote>\n<ul>\n<li>Write and edit examples<\/li>\n<\/ul>\n<blockquote><p><em>PowerShell HelpWriter<\/em> takes care of the formatting and the file structure\u00a0so you can focus on the content.<\/p><\/blockquote>\n<blockquote><p><a href=\"http:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2015\/02\/image5.png\"><img loading=\"lazy\" decoding=\"async\" style=\"display: inline; border: 0px;\" title=\"image\" src=\"http:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2015\/02\/image_thumb5.png\" alt=\"image\" width=\"492\" height=\"301\" border=\"0\" \/><\/a><\/p><\/blockquote>\n<ul>\n<li>Confused by Inputs and Outputs? <em>PowerShell HelpWriter<\/em> gets the input and output types from the command code. You just write the descriptions.<\/li>\n<\/ul>\n<blockquote><p><a href=\"http:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2015\/02\/image6.png\"><img loading=\"lazy\" decoding=\"async\" style=\"display: inline; border: 0px;\" title=\"image\" src=\"http:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2015\/02\/image_thumb6.png\" alt=\"image\" width=\"485\" height=\"166\" border=\"0\" \/><\/a><\/p><\/blockquote>\n<ul>\n<li>Support online help with a URL in the first related link.<\/li>\n<\/ul>\n<blockquote><p><a href=\"http:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2015\/02\/image7.png\"><img loading=\"lazy\" decoding=\"async\" style=\"display: inline; border: 0px;\" title=\"image\" src=\"http:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2015\/02\/image_thumb7.png\" alt=\"image\" width=\"487\" height=\"84\" border=\"0\" \/><\/a><\/p><\/blockquote>\n<ul>\n<li>View and edit your help files in the built-in XML editor.<\/li>\n<\/ul>\n<blockquote><p><a href=\"http:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2015\/02\/image8.png\"><img loading=\"lazy\" decoding=\"async\" style=\"display: inline; border: 0px;\" title=\"image\" src=\"http:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2015\/02\/image_thumb8.png\" alt=\"image\" width=\"457\" height=\"215\" border=\"0\" \/><\/a><\/p><\/blockquote>\n<ul>\n<li>And, if you&#8217;ve edited the XML, be sure to validate your help file before shipping.<\/li>\n<\/ul>\n<blockquote><p><a href=\"http:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2015\/02\/image9.png\"><img loading=\"lazy\" decoding=\"async\" style=\"display: inline; border: 0px;\" title=\"image\" src=\"http:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2015\/02\/image_thumb9.png\" alt=\"image\" width=\"481\" height=\"139\" border=\"0\" \/><\/a><\/p><\/blockquote>\n<ul>\n<li><em>PowerShell HelpWriter<\/em> generates Get-Help-ready help files. Add them to your module, Updatable Help CAB, and open-source repo.<\/li>\n<\/ul>\n<blockquote><p><a href=\"http:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2015\/02\/image10.png\"><img loading=\"lazy\" decoding=\"async\" style=\"display: inline; border: 0px;\" title=\"image\" src=\"http:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2015\/02\/image_thumb10.png\" alt=\"image\" width=\"542\" height=\"323\" border=\"0\" \/><\/a><\/p><\/blockquote>\n<p>&nbsp;<\/p>\n<p>PowerShell HelpWriter 2015 is available now\u00a0from SAPIEN Technologies, Inc. If you have a subscription to the SAPIEN Software Suite, you get <em>PowerShell HelpWriter 2015<\/em> at no additional cost.<\/p>\n<p>For more information and a free trial, see <a href=\"http:\/\/www.sapien.com\/software\/powershell_helpwriter\"><strong><em>PowerShell HelpWriter<\/em><\/strong><\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>The help system in Windows PowerShell is well known and much loved. But, it has been very difficult to create XML help files that comply with the PSMAML schema that the Get-Help cmdlet requires. Until now. Introducing PowerShell HelpWriter by SAPIEN Technologies, Inc., the first professional, fully featured help authoring studio for Windows PowerShell help. [&hellip;]<\/p>\n","protected":false},"author":31,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":""},"categories":[952],"tags":[953],"class_list":["post-8685","post","type-post","status-publish","format-standard","hentry","category-powershell-help-writer","tag-powershell-help-writer"],"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/8685","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/users\/31"}],"replies":[{"embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/comments?post=8685"}],"version-history":[{"count":9,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/8685\/revisions"}],"predecessor-version":[{"id":8838,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/8685\/revisions\/8838"}],"wp:attachment":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/media?parent=8685"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/categories?post=8685"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/tags?post=8685"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}