{"id":12609,"date":"2016-08-08T06:00:45","date_gmt":"2016-08-08T13:00:45","guid":{"rendered":"https:\/\/www.sapien.com\/blog\/?p=12609"},"modified":"2016-10-27T10:49:34","modified_gmt":"2016-10-27T17:49:34","slug":"writing-help-for-dynamic-parameters","status":"publish","type":"post","link":"https:\/\/dev.sapien.com\/blog\/2016\/08\/08\/writing-help-for-dynamic-parameters\/","title":{"rendered":"Writing Help for Dynamic Parameters"},"content":{"rendered":"<p>Because dynamic parameters can be added to a command from multiple sources, the command author (who writes the help) cannot predict the dynamic parameters that might be available at runtime. Therefore, Get-Help expects dynamic parameters to be documented in the help file for the code that adds the dynamic parameters; not the code that has the dynamic parameters.<\/p>\n<p>This makes sense in theory, but, in practice, it&#8217;s not discoverable and it&#8217;s very confusing for users.<\/p>\n<p>To write help for the dynamic parameters that you add to cmdlets and functions, you need to sneak it into the description. I&#8217;ll show you how. The article ends with suggestions for making this process easier. I welcome your suggestions, too.<\/p>\n<p><a href=\"http:\/\/info.sapien.com\/index.php\/scripting\/scripting-help\/writing-help-for-dynamic-parameters\" target=\"_new\">Read the full post in the SAPIEN Information Center<\/a>.<\/p>\n<p><em>June Blender is a technology evangelist at SAPIEN Technologies, Inc. and a Windows PowerShell MVP. You can reach her at <span id=\"cloak33701\"><span id=\"cloak9078b420252769c443f9cc7f78816a07\"><a href=\"mailto:juneb@sapien.com\">juneb@sapien.com<\/a><\/span><\/span> or follow her on Twitter at <a href=\"https:\/\/twitter.com\/juneb_get_help\" target=\"_blank\">@juneb_get_help<\/a>.<\/em><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Because dynamic parameters can be added to a command from multiple sources, the command author (who writes the help) cannot predict the dynamic parameters that might be available at runtime. Therefore, Get-Help expects dynamic parameters to be documented in the help file for the code that adds the dynamic parameters; not the code that has [&hellip;]<\/p>\n","protected":false},"author":31,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"om_disable_all_campaigns":false,"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":""},"categories":[2,1143,25],"tags":[904,450,966,1172],"class_list":["post-12609","post","type-post","status-publish","format-standard","hentry","category-general","category-powershell","category-windows-powershell","tag-comment-based-help","tag-help","tag-powershell-help","tag-xml-help"],"aioseo_notices":[],"aioseo_head":"\n\t\t<!-- All in One SEO 5.0.1 - aioseo.com -->\n\t<meta name=\"description\" content=\"Because dynamic parameters can be added to a command from multiple sources, the command author (who writes the help) cannot predict the dynamic parameters that might be available at runtime. Therefore, Get-Help expects dynamic parameters to be documented in the help file for the code that adds the dynamic parameters; not the code that has\" \/>\n\t<meta name=\"robots\" content=\"max-image-preview:large\" \/>\n\t<meta name=\"author\" content=\"June Blender\"\/>\n\t<link rel=\"canonical\" href=\"https:\/\/dev.sapien.com\/blog\/2016\/08\/08\/writing-help-for-dynamic-parameters\/\" \/>\n\t<meta name=\"generator\" content=\"All in One SEO (AIOSEO) 5.0.1\" \/>\n\t\t<meta property=\"og:locale\" content=\"en_US\" \/>\n\t\t<meta property=\"og:site_name\" content=\"DEV SAPIEN Blog - Tools for IT Success\" \/>\n\t\t<meta property=\"og:type\" content=\"article\" \/>\n\t\t<meta property=\"og:title\" content=\"Writing Help for Dynamic Parameters - DEV SAPIEN Blog\" \/>\n\t\t<meta property=\"og:description\" content=\"Because dynamic parameters can be added to a command from multiple sources, the command author (who writes the help) cannot predict the dynamic parameters that might be available at runtime. Therefore, Get-Help expects dynamic parameters to be documented in the help file for the code that adds the dynamic parameters; not the code that has\" \/>\n\t\t<meta property=\"og:url\" content=\"https:\/\/dev.sapien.com\/blog\/2016\/08\/08\/writing-help-for-dynamic-parameters\/\" \/>\n\t\t<meta property=\"article:published_time\" content=\"2016-08-08T13:00:45+00:00\" \/>\n\t\t<meta property=\"article:modified_time\" content=\"2016-10-27T17:49:34+00:00\" \/>\n\t\t<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n\t\t<meta name=\"twitter:title\" content=\"Writing Help for Dynamic Parameters - DEV SAPIEN Blog\" \/>\n\t\t<meta name=\"twitter:description\" content=\"Because dynamic parameters can be added to a command from multiple sources, the command author (who writes the help) cannot predict the dynamic parameters that might be available at runtime. Therefore, Get-Help expects dynamic parameters to be documented in the help file for the code that adds the dynamic parameters; not the code that has\" \/>\n\t\t<script type=\"application\/ld+json\" class=\"aioseo-schema\">\n\t\t\t{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"BlogPosting\",\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/2016\\\/08\\\/08\\\/writing-help-for-dynamic-parameters\\\/#blogposting\",\"name\":\"Writing Help for Dynamic Parameters - DEV SAPIEN Blog\",\"headline\":\"Writing Help for Dynamic Parameters\",\"author\":{\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/author\\\/juneblender\\\/#author\"},\"publisher\":{\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/#organization\"},\"datePublished\":\"2016-08-08T06:00:45-07:00\",\"dateModified\":\"2016-10-27T10:49:34-07:00\",\"inLanguage\":\"en-US\",\"commentCount\":7,\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/2016\\\/08\\\/08\\\/writing-help-for-dynamic-parameters\\\/#webpage\"},\"isPartOf\":{\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/2016\\\/08\\\/08\\\/writing-help-for-dynamic-parameters\\\/#webpage\"},\"articleSection\":\"General, PowerShell, Windows PowerShell, comment based help, Help, PowerShell Help, XML Help\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/2016\\\/08\\\/08\\\/writing-help-for-dynamic-parameters\\\/#breadcrumblist\",\"itemListElement\":[{\"@type\":\"ListItem\",\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog#listItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/dev.sapien.com\\\/blog\",\"nextItem\":{\"@type\":\"ListItem\",\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/topics\\\/general\\\/#listItem\",\"name\":\"General\"}},{\"@type\":\"ListItem\",\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/topics\\\/general\\\/#listItem\",\"position\":2,\"name\":\"General\",\"item\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/topics\\\/general\\\/\",\"nextItem\":{\"@type\":\"ListItem\",\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/2016\\\/08\\\/08\\\/writing-help-for-dynamic-parameters\\\/#listItem\",\"name\":\"Writing Help for Dynamic Parameters\"},\"previousItem\":{\"@type\":\"ListItem\",\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog#listItem\",\"name\":\"Home\"}},{\"@type\":\"ListItem\",\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/2016\\\/08\\\/08\\\/writing-help-for-dynamic-parameters\\\/#listItem\",\"position\":3,\"name\":\"Writing Help for Dynamic Parameters\",\"previousItem\":{\"@type\":\"ListItem\",\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/topics\\\/general\\\/#listItem\",\"name\":\"General\"}}]},{\"@type\":\"Organization\",\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/#organization\",\"name\":\"DEV SAPIEN Blog\",\"description\":\"Tools for IT Success\",\"url\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/\"},{\"@type\":\"Person\",\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/author\\\/juneblender\\\/#author\",\"url\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/author\\\/juneblender\\\/\",\"name\":\"June Blender\"},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/2016\\\/08\\\/08\\\/writing-help-for-dynamic-parameters\\\/#webpage\",\"url\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/2016\\\/08\\\/08\\\/writing-help-for-dynamic-parameters\\\/\",\"name\":\"Writing Help for Dynamic Parameters - DEV SAPIEN Blog\",\"description\":\"Because dynamic parameters can be added to a command from multiple sources, the command author (who writes the help) cannot predict the dynamic parameters that might be available at runtime. Therefore, Get-Help expects dynamic parameters to be documented in the help file for the code that adds the dynamic parameters; not the code that has\",\"inLanguage\":\"en-US\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/#website\"},\"breadcrumb\":{\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/2016\\\/08\\\/08\\\/writing-help-for-dynamic-parameters\\\/#breadcrumblist\"},\"author\":{\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/author\\\/juneblender\\\/#author\"},\"creator\":{\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/author\\\/juneblender\\\/#author\"},\"datePublished\":\"2016-08-08T06:00:45-07:00\",\"dateModified\":\"2016-10-27T10:49:34-07:00\"},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/#website\",\"url\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/\",\"name\":\"DEV SAPIEN Blog\",\"description\":\"Tools for IT Success\",\"inLanguage\":\"en-US\",\"publisher\":{\"@id\":\"https:\\\/\\\/dev.sapien.com\\\/blog\\\/#organization\"}}]}\n\t\t<\/script>\n\t\t<!-- All in One SEO -->\n\n","aioseo_head_json":{"title":"Writing Help for Dynamic Parameters - DEV SAPIEN Blog","description":"Because dynamic parameters can be added to a command from multiple sources, the command author (who writes the help) cannot predict the dynamic parameters that might be available at runtime. Therefore, Get-Help expects dynamic parameters to be documented in the help file for the code that adds the dynamic parameters; not the code that has","canonical_url":"https:\/\/dev.sapien.com\/blog\/2016\/08\/08\/writing-help-for-dynamic-parameters\/","robots":"max-image-preview:large","keywords":"","webmasterTools":{"miscellaneous":""},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"BlogPosting","@id":"https:\/\/dev.sapien.com\/blog\/2016\/08\/08\/writing-help-for-dynamic-parameters\/#blogposting","name":"Writing Help for Dynamic Parameters - DEV SAPIEN Blog","headline":"Writing Help for Dynamic Parameters","author":{"@id":"https:\/\/dev.sapien.com\/blog\/author\/juneblender\/#author"},"publisher":{"@id":"https:\/\/dev.sapien.com\/blog\/#organization"},"datePublished":"2016-08-08T06:00:45-07:00","dateModified":"2016-10-27T10:49:34-07:00","inLanguage":"en-US","commentCount":7,"mainEntityOfPage":{"@id":"https:\/\/dev.sapien.com\/blog\/2016\/08\/08\/writing-help-for-dynamic-parameters\/#webpage"},"isPartOf":{"@id":"https:\/\/dev.sapien.com\/blog\/2016\/08\/08\/writing-help-for-dynamic-parameters\/#webpage"},"articleSection":"General, PowerShell, Windows PowerShell, comment based help, Help, PowerShell Help, XML Help"},{"@type":"BreadcrumbList","@id":"https:\/\/dev.sapien.com\/blog\/2016\/08\/08\/writing-help-for-dynamic-parameters\/#breadcrumblist","itemListElement":[{"@type":"ListItem","@id":"https:\/\/dev.sapien.com\/blog#listItem","position":1,"name":"Home","item":"https:\/\/dev.sapien.com\/blog","nextItem":{"@type":"ListItem","@id":"https:\/\/dev.sapien.com\/blog\/topics\/general\/#listItem","name":"General"}},{"@type":"ListItem","@id":"https:\/\/dev.sapien.com\/blog\/topics\/general\/#listItem","position":2,"name":"General","item":"https:\/\/dev.sapien.com\/blog\/topics\/general\/","nextItem":{"@type":"ListItem","@id":"https:\/\/dev.sapien.com\/blog\/2016\/08\/08\/writing-help-for-dynamic-parameters\/#listItem","name":"Writing Help for Dynamic Parameters"},"previousItem":{"@type":"ListItem","@id":"https:\/\/dev.sapien.com\/blog#listItem","name":"Home"}},{"@type":"ListItem","@id":"https:\/\/dev.sapien.com\/blog\/2016\/08\/08\/writing-help-for-dynamic-parameters\/#listItem","position":3,"name":"Writing Help for Dynamic Parameters","previousItem":{"@type":"ListItem","@id":"https:\/\/dev.sapien.com\/blog\/topics\/general\/#listItem","name":"General"}}]},{"@type":"Organization","@id":"https:\/\/dev.sapien.com\/blog\/#organization","name":"DEV SAPIEN Blog","description":"Tools for IT Success","url":"https:\/\/dev.sapien.com\/blog\/"},{"@type":"Person","@id":"https:\/\/dev.sapien.com\/blog\/author\/juneblender\/#author","url":"https:\/\/dev.sapien.com\/blog\/author\/juneblender\/","name":"June Blender"},{"@type":"WebPage","@id":"https:\/\/dev.sapien.com\/blog\/2016\/08\/08\/writing-help-for-dynamic-parameters\/#webpage","url":"https:\/\/dev.sapien.com\/blog\/2016\/08\/08\/writing-help-for-dynamic-parameters\/","name":"Writing Help for Dynamic Parameters - DEV SAPIEN Blog","description":"Because dynamic parameters can be added to a command from multiple sources, the command author (who writes the help) cannot predict the dynamic parameters that might be available at runtime. Therefore, Get-Help expects dynamic parameters to be documented in the help file for the code that adds the dynamic parameters; not the code that has","inLanguage":"en-US","isPartOf":{"@id":"https:\/\/dev.sapien.com\/blog\/#website"},"breadcrumb":{"@id":"https:\/\/dev.sapien.com\/blog\/2016\/08\/08\/writing-help-for-dynamic-parameters\/#breadcrumblist"},"author":{"@id":"https:\/\/dev.sapien.com\/blog\/author\/juneblender\/#author"},"creator":{"@id":"https:\/\/dev.sapien.com\/blog\/author\/juneblender\/#author"},"datePublished":"2016-08-08T06:00:45-07:00","dateModified":"2016-10-27T10:49:34-07:00"},{"@type":"WebSite","@id":"https:\/\/dev.sapien.com\/blog\/#website","url":"https:\/\/dev.sapien.com\/blog\/","name":"DEV SAPIEN Blog","description":"Tools for IT Success","inLanguage":"en-US","publisher":{"@id":"https:\/\/dev.sapien.com\/blog\/#organization"}}]},"og:locale":"en_US","og:site_name":"DEV SAPIEN Blog - Tools for IT Success","og:type":"article","og:title":"Writing Help for Dynamic Parameters - DEV SAPIEN Blog","og:description":"Because dynamic parameters can be added to a command from multiple sources, the command author (who writes the help) cannot predict the dynamic parameters that might be available at runtime. Therefore, Get-Help expects dynamic parameters to be documented in the help file for the code that adds the dynamic parameters; not the code that has","og:url":"https:\/\/dev.sapien.com\/blog\/2016\/08\/08\/writing-help-for-dynamic-parameters\/","article:published_time":"2016-08-08T13:00:45+00:00","article:modified_time":"2016-10-27T17:49:34+00:00","twitter:card":"summary_large_image","twitter:title":"Writing Help for Dynamic Parameters - DEV SAPIEN Blog","twitter:description":"Because dynamic parameters can be added to a command from multiple sources, the command author (who writes the help) cannot predict the dynamic parameters that might be available at runtime. Therefore, Get-Help expects dynamic parameters to be documented in the help file for the code that adds the dynamic parameters; not the code that has"},"aioseo_meta_data":{"post_id":"12609","title":null,"description":null,"keywords":null,"keyphrases":null,"focus_keyword":null,"additional_keywords":null,"truseo_locale":null,"primary_term":null,"canonical_url":null,"og_title":null,"og_description":null,"og_object_type":"default","og_image_type":"default","og_image_custom_url":null,"og_image_custom_fields":null,"og_image_url":null,"og_image_width":null,"og_image_height":null,"og_video":null,"og_custom_url":null,"og_article_section":null,"og_article_tags":null,"twitter_use_og":false,"twitter_card":"default","twitter_image_type":"default","twitter_image_custom_url":null,"twitter_image_custom_fields":null,"twitter_image_url":null,"twitter_title":null,"twitter_description":null,"schema_type":"default","schema_type_options":null,"schema":{"blockGraphs":[],"customGraphs":[],"default":{"data":{"Article":[],"Course":[],"Dataset":[],"FAQPage":[],"Movie":[],"Person":[],"Product":[],"ProductReview":[],"Car":[],"Recipe":[],"Service":[],"SoftwareApplication":[],"WebPage":[]},"graphName":"","isEnabled":true},"graphs":[]},"pillar_content":false,"robots_default":true,"robots_noindex":false,"robots_noarchive":false,"robots_nosnippet":false,"robots_nofollow":false,"robots_noimageindex":false,"robots_noodp":false,"robots_notranslate":false,"robots_max_snippet":null,"robots_max_videopreview":null,"robots_max_imagepreview":"large","priority":null,"frequency":null,"local_seo":null,"limit_modified_date":false,"ai":null,"breadcrumb_settings":null,"seo_analyzer_scan_date":null,"created":"2026-08-28 16:02:35","updated":"2026-08-28 16:02:35"},"aioseo_breadcrumb":"<div class=\"aioseo-breadcrumbs\"><span class=\"aioseo-breadcrumb\">\n\t\t\t<a href=\"https:\/\/dev.sapien.com\/blog\" title=\"Home\">Home<\/a>\n\t\t<\/span><span class=\"aioseo-breadcrumb-separator\">&raquo;<\/span><span class=\"aioseo-breadcrumb\">\n\t\t\t<a href=\"https:\/\/dev.sapien.com\/blog\/topics\/general\/\" title=\"General\">General<\/a>\n\t\t<\/span><span class=\"aioseo-breadcrumb-separator\">&raquo;<\/span><span class=\"aioseo-breadcrumb\">\n\t\t\tWriting Help for Dynamic Parameters\n\t\t<\/span><\/div>","aioseo_breadcrumb_json":[{"label":"Home","link":"https:\/\/dev.sapien.com\/blog"},{"label":"General","link":"https:\/\/dev.sapien.com\/blog\/topics\/general\/"},{"label":"Writing Help for Dynamic Parameters","link":"https:\/\/dev.sapien.com\/blog\/2016\/08\/08\/writing-help-for-dynamic-parameters\/"}],"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/12609","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=12609"}],"version-history":[{"count":4,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/12609\/revisions"}],"predecessor-version":[{"id":12614,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/12609\/revisions\/12614"}],"wp:attachment":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/media?parent=12609"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/categories?post=12609"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/tags?post=12609"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}