Votes from Connect: 6

Original Date Submitted: 9/11/2014 4:15:39 AM

Description:
Contact Information
Handle: Kirk Munro
Site Name: PowerShell
Feedback ID: 968858

Frequency: Always Happens
Regression: Yes, this happens in all previous versions

Problem Description:
Help documentation is more time consuming than it needs to be. My biggest pain point with help is that I like to include links to all other commands with the same noun to aid in discoverability. Sure, there is Get-Command -Noun ..., but it is useful in help documentation to include links to those commands as well. This also helps modern help tools link to those commands more easily.

As I create a module, adding additional commands, I really dislike having to circle back to the comment-based help and add the new commands to the links. Ditto when renaming a command.

I would like to see help automatically include any commands that have the same noun in the links of related items in the command help. With that in place, command authors would only have to worry about including links to online help, or links to other commands that may not be as obviously related but that you would want end users to be able to discover via help. The rest (links to commands with the same noun) would just be magic. As a plus, anyone extending a set of commands with additional verbs could have their commands automatically linked as well, without having to set up the links themselves.

Product Studio item created by Connect Synchronizer due to creation of feedback ID 968858 (http://connect.microsoft.com/PowerShell/feedback/ViewFeedback.aspx?FeedbackID=968858).

Repro Steps:
New-Module -Name Test -ScriptBlock {

<#

.SYNOPSIS

    Get something.

.DESCRIPTION

    The Get-Something command gets something.

#>

function Get-Something {

    [CmdletBinding()]

    param()

}


<#

.SYNOPSIS

    Set something.

.DESCRIPTION

    The Set-Something command gets something.

#>

function Set-Something {

    [CmdletBinding()]

    param()

}

} | Import-Module
Get-Help Get-Something
Get-Help Set-Something

Expected Results:
You should see Set-Something in the RELATED LINKS section of Get-Something help and Get-Something in the RELATED LINKS section of Set-Something help because they share the same noun.

Internal BugId: 9994