You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|`src/data/`| Static module data that ships with the module. |
82
82
|`examples/`| Realistic user scenarios, not copies of command help. |
83
+
|`docs/`| Product documentation source when the module needs documentation beyond generated command help. |
83
84
|`tests/`| Pester tests and test data. |
84
85
|`icon/`| Module icon assets. |
85
86
@@ -168,7 +169,17 @@ Dependabot PRs still go through normal review. Automated dependency updates are
168
169
169
170
## README default
170
171
171
-
A module README is a landing page, not the command reference. It should help a user identify the module, install it, see what it can do, and then find generated documentation.
172
+
A module README is a start page, not the command reference or full manual. It brings a reader in, answers the first questions, and sends them to the right documentation surface.
173
+
174
+
The README answers these questions, in this order:
175
+
176
+
| Question | Module README responsibility |
177
+
| --- | --- |
178
+
| What is it? | Name the module and define its scope in one short paragraph. |
179
+
| Why should I care? | State the value or kind of task the module makes easier. |
180
+
| How do I get it? | Show the PowerShell Gallery install and import commands. |
181
+
| How does it work? | Show one to three representative capabilities or usage examples. |
182
+
| How do I get more info? | Link to generated module documentation and PowerShell help. |
172
183
173
184
Module installation examples must use PSResourceGet:
174
185
@@ -183,7 +194,7 @@ For implemented modules, use this shape:
183
194
````markdown
184
195
# <ModuleName>
185
196
186
-
<One short paragraph describing the module from the user's perspective.>
Use this section as a short showcase. Show the most important things the module makes possible with one to three realistic examples.
210
+
Use this section as a short showcase and introduction to how the module works. Show the most important things the module makes possible with one to three realistic examples.
200
211
201
212
The goal is discovery and marketing, not exhaustive command documentation. A reader should understand why the module exists and what kind of tasks it helps with.
README pages may include a short capabilities or usage showcase before the documentation link. Keep that section focused on discovery and marketing: show representative outcomes, not every command, parameter, or edge case.
231
+
README pages should include a short capabilities or usage showcase before the documentation link when the module has working capabilities. Keep that section focused on discovery and marketing: show representative outcomes, not every command, parameter, or edge case.
221
232
222
233
README pages should not duplicate generated command documentation. Do not add full command inventories, parameter tables, or long reference sections when those details are already produced from comment-based help.
223
234
235
+
Do not add a community-file or policy link section by default. Readers can find standard repository files such as `LICENSE`, `CONTRIBUTING.md`, `SECURITY.md`, and `CODE_OF_CONDUCT.md` through GitHub conventions and the repository file tree. Link them only when the module has an unusual rule the user must know before using it.
236
+
224
237
## Placeholder and in-progress repositories
225
238
226
239
If a repository is reserved for a future module or still contains scaffold code, say that directly. Do not leave `{{ NAME }}`, `{{ DESCRIPTION }}`, `PSModuleTemplate`, `Greet-Entity`, or similar template examples in the README.
@@ -269,6 +282,7 @@ Use these defaults:
269
282
- Command synopsis, parameters, examples, links, and outputs live in comment-based help.
270
283
- Group overview pages live next to public command groups in `src/functions/public/<Group>/<Group>.md`.
271
284
- Realistic end-to-end scenarios live in `examples/`.
285
+
- Product docs beyond generated command help live under `docs/` and publish through GitHub Pages or the initiative's module documentation site.
272
286
- README capability examples are short, representative, and user-facing.
0 commit comments