Skip to content

docs: reference ADR 0038: Public-by-Default Documentation Policy #158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yeoldegrove wants to merge 1 commit into
base: main
Choose a base branch
from
+15 −4
Open

docs: reference ADR 0038: Public-by-Default Documentation Policy #158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions docs/contributing/documentation/documentation_workflow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ internal or external contributors, users or decision makers.

In the context of this Documentation Hub, anything that has implication to the
"outside". Meaning other users, operators, developers or decision makers needs
to be documented accordingly.
to be documented accordingly (see [ADR 0038](/reference/adr/0038-public-by-default-documentation-policy) for the full policy).

This includes, but is not limited to:

Expand All @@ -46,7 +46,8 @@ This includes, but is not limited to:
- Information about who is developing the project

Of course this does not apply to purely internal changes like code cleanup
contributions or similar that have no outside effect.
contributions or similar that have no outside effect. For a precise definition
of what qualifies as internal, see [ADR 0038](/reference/adr/0038-public-by-default-documentation-policy).

## Who Is Responsible for Maintaining Documentation?

Expand Down Expand Up @@ -143,9 +144,14 @@ The review validates:
- **Style and Inclusivity**: Language follows the project's
[quality criteria](./writing_good_docs.md), all images have appropriate alt
text descriptions
- **Maintainability**: Documentation follows single source of truth principle,
- **Maintainability**: Documentation follows the [single source of truth](/reference/adr/0038-public-by-default-documentation-policy) principle,
ownership is clear, no unnecessary duplication

## Architecture Decisions

- [ADR 0038: Public-by-Default Documentation Policy](/reference/adr/0038-public-by-default-documentation-policy)
— defines what must be public, what stays internal, and the delta-only model for internal supplements.

## Related Topics

<RelatedTopics />
7 changes: 6 additions & 1 deletion docs/contributing/documentation/writing_good_docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ Documents should:

Documentation should be structured to minimize maintenance burden:

- Follow the "single source of truth" principle; don't duplicate information
- Follow the [single source of truth](/reference/adr/0038-public-by-default-documentation-policy) principle; don't duplicate information
across multiple pages
- Include version information where relevant
- Clearly indicate ownership:
Expand Down Expand Up @@ -243,6 +243,11 @@ Use this checklist when reviewing or submitting documentation:
- ✅ Known issues section included (if applicable)
- ✅ External dependencies documented (if applicable)

## Architecture Decisions

- [ADR 0038: Public-by-Default Documentation Policy](/reference/adr/0038-public-by-default-documentation-policy)
— the formal policy backing the single-source-of-truth and no-duplication maintainability markers.

## Related Topics

<RelatedTopics />
Loading