@@ -29,7 +29,7 @@ in `.github/instructions/powershell-platyps.instructions.md`.
2929- ** DOC-06** ` .OUTPUTS ` names the same type as ` [OutputType()] ` . ` .INPUTS ` names the type that can be
3030 piped in, or says ` None ` .
3131- ** DOC-07** Help MUST NOT contain a version number, a date, or a change history. An author name is
32- added only when the user supplies one.
32+ added only when the user supplies one or ` .github/powershell-attribution.md ` lists one (DOC-18) .
3333- ** DOC-08** Each ` .EXAMPLE ` starts with a command that runs as written, followed by a blank line and
3434 a sentence saying what it does. An explanatory line placed before that blank line MUST start with
3535 ` # ` and MUST NOT be the first line.
@@ -55,11 +55,16 @@ in `.github/instructions/powershell-platyps.instructions.md`.
5555 A ` DURATION: ` line is added only for a time that was measured.
5656- ** DOC-15** ` .NOTES ` holds security considerations (permissions and data handling), performance
5757 characteristics, and known limitations with their workarounds. It holds the author's name, blog,
58- and LinkedIn address only when the user supplies them (DOC-07).
58+ LinkedIn address, and other profiles only when the user supplies them or the project's
59+ attribution file lists them (DOC-07, DOC-18).
5960- ** DOC-16** List references with one ` .LINK ` keyword for each: related commands, the online
6061 documentation of the command, and Microsoft documentation.
6162- ** DOC-17** Where they have been measured, help documents typical execution time, memory use, and
6263 scalability. It states no performance figure that was not measured (DOC-05).
64+ - ** DOC-18** When the project has ` .github/powershell-attribution.md ` , take the author details from
65+ it: the ` AUTHOR: ` lines of ` .NOTES ` in new help, and the manifest keys of MOD-03. Use each line
66+ that has a value, with its label, in the file's order. A line without a value is left out and
67+ MUST NOT be filled in from anywhere else. Existing help is not changed only to add the details.
6368
6469### Comments
6570
@@ -219,6 +224,39 @@ Test-Connection
219224Tested on PowerShell 7.6 and Windows PowerShell 5.1: ` Get-Help ` keeps these lines and the blank
220225lines between them, and lists each ` .LINK ` as one related link.
221226
227+ ** DOC-18.** The attribution file is a list of labelled lines that the project fills in:
228+
229+ ``` markdown
230+ - Author: Alex Example
231+ - Company:
232+ - Copyright holder: Alex Example
233+ - Blog: https://blog.example.com
234+ - LinkedIn: https://www.linkedin.com/in/alex-example
235+ ```
236+
237+ New help then ends its ` .NOTES ` with the lines that have a value. ` Company ` is empty, so it is left
238+ out; ` Copyright holder ` belongs to the manifest only:
239+
240+ ``` powershell
241+ <#
242+ .NOTES
243+ KNOWN LIMITATIONS:
244+ - Computers must be reachable through WinRM.
245+
246+ AUTHOR:
247+ - Author: Alex Example
248+ - Blog: https://blog.example.com
249+ - LinkedIn: https://www.linkedin.com/in/alex-example
250+ #>
251+ ```
252+
253+ Tested on PowerShell 7.6 and Windows PowerShell 5.1: ` Get-Help -Full ` shows the ` AUTHOR: ` block as
254+ written, after the other notes.
255+
256+ The standards installer creates the file when it is missing and never changes it afterwards. It
257+ starts from the profile of the project's GitHub owner when the standards repository has one, and
258+ from an empty template otherwise.
259+
222260** DOC-20.**
223261
224262``` powershell
0 commit comments