Skip to content

Commit 3e196a6

Browse files
📖 [Docs]: Repository READMEs are concise start pages (#21)
Repository README defaults now define the README as a concise start page instead of a manual. The central standard explains the questions a README should answer, when product documentation belongs in `docs/` and GitHub Pages, and when a fuller README is appropriate for GitHub Actions and reusable workflows. > ⚠️ This PR has no linked issue. Consider creating one for traceability. ## Changed: README defaults are framed as a start page The repository standard now says a README should answer: what is it, why should I care, how do I get it, how does it work, and how do I get more information. ## Changed: Product documentation ownership is explicit The standard now distinguishes short README start pages from product documentation. PowerShell modules and similar products should keep deeper docs in `docs/` and publish them, while GitHub Actions and reusable workflow repositories can use a fuller README because that is the expected interface documentation surface. ## Technical Details - Updates `src/docs/Ways-of-Working/Repository-Standard.md`. - Keeps implementation details delegated to initiative documentation repositories. - Does not align individual repositories yet.
1 parent 2bc2b81 commit 3e196a6

1 file changed

Lines changed: 30 additions & 9 deletions

File tree

src/docs/Ways-of-Working/Repository-Standard.md

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Every repository must carry the files that make it understandable and governable
1515

1616
| File | Requirement |
1717
| --- | --- |
18-
| `README.md` | Explains the repository purpose, current capabilities, and where to find deeper docs. |
18+
| `README.md` | Acts as the repository start page: purpose, value, access, first mental model, and where to go next. |
1919
| `LICENSE` | States the legal terms for reuse and redistribution. |
2020
| `CONTRIBUTING.md` | Explains how to contribute or links to the initiative contribution guide. |
2121
| `SECURITY.md` | Explains supported versions and private vulnerability reporting. |
@@ -33,19 +33,40 @@ Repository types may require additional files. For example, a PowerShell module
3333

3434
## README defaults
3535

36-
The README is the repository front door. It must be short enough to stay current and specific enough that a human or agent can understand the repository before reading source code.
36+
The README is the repository start page. It brings a reader in, gives them the first useful mental model, and then points them to the right deeper surface. It must be short enough to stay current and specific enough that a human or agent can understand the repository before reading source code.
3737

38-
A README should include:
38+
A README answers these questions, in this order:
3939

40-
- What the repository is.
41-
- What it currently does.
42-
- How to install or use the artifact, if applicable.
43-
- Where generated or detailed documentation lives.
44-
- How to contribute or where to find contribution guidance.
45-
- Status if the repository is a placeholder, archive, experiment, or in progress.
40+
| Question | README responsibility |
41+
| --- | --- |
42+
| What is it? | Name the product or artifact and its scope. |
43+
| Why should I care? | State the value or problem it solves. |
44+
| How do I get it? | Show the shortest install, download, import, or usage entry point. |
45+
| How does it work? | Give a concise introduction to the main capability or operating model. |
46+
| How do I get more info? | Point to the documentation surface that owns the details. |
47+
48+
Do not use the README as a community-file index. Assume readers can find standard repository files such as `LICENSE`, `CONTRIBUTING.md`, `SECURITY.md`, and `CODE_OF_CONDUCT.md` through GitHub's UI and repository conventions. The README should mention them only when the repository has an unusual rule that readers must know before using the product.
49+
50+
Do not repeat repository-sidebar information in prose. If GitHub already exposes the repository description, deployments, releases, or site URL, the README may rely on those surfaces unless the information is necessary to answer the start-page questions.
4651

4752
Do not leave template placeholders such as `{{ NAME }}`, `{{ DESCRIPTION }}`, `YourModuleName`, or fake example commands in a repository README after the initial setup commit.
4853

54+
## Product documentation defaults
55+
56+
The README is not the complete product manual. Important product documentation belongs in a documentation surface that can grow without bloating the start page.
57+
58+
Default expectations by repository type:
59+
60+
| Repository type | Documentation default |
61+
| --- | --- |
62+
| PowerShell modules | Product docs live under `docs/` and are published to GitHub Pages or the initiative's module documentation site. The README stays short and points there. |
63+
| Libraries, services, CLIs, and applications | Product docs live under `docs/` and are published when the product needs more than a small README. |
64+
| GitHub Actions | The README is the main documentation surface because GitHub Actions users expect inputs, outputs, permissions, and examples next to `action.yml`. |
65+
| Reusable workflows | The README is the main documentation surface because callers need workflow interface, permissions, secrets, and examples in the repository. |
66+
| Documentation repositories | The published site is the product. The repository README only explains the source repo and local contribution/build entry points. |
67+
68+
Initiative docs define the implementation: exact folder layout, publishing workflow, URL convention, and which repositories are exceptions. MSX defines the expectation that product docs have an owner and that README pages stay small.
69+
4970
## Dependency and supply-chain defaults
5071

5172
Every repository that has external dependencies must configure automated update pull requests. Dependabot is the default GitHub-native mechanism unless the initiative documents a different implementation.

0 commit comments

Comments
 (0)