Skip to content

Update quality.rst #121

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
DahanDv wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update quality.rst #121

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
10 changes: 5 additions & 5 deletions quality.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ Diátaxis is an approach to *quality* in documentation.
"Quality" is a word in danger of losing some of its meaning; it's something we
all approve of, but rarely risk trying to describe in any rigorous way. We
want quality in our documentation, but much less often specify what exactly
what we mean by that.
we mean by that.

All the same, we can generally point to examples of "high quality
documentation" when asked, and can identify lapses in quality when we see
All the same, we can generally point to examples of "high-quality
Copy link

@corneliusroemer corneliusroemer Feb 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, per https://english.stackexchange.com/questions/487351/usage-of-high-quality-vs-high-quality

documentation" when asked, and we can identify lapses in quality when we see
them - and more than that, we often agree when we do. This suggests that
we still have a useful grasp on the notion of quality.

Expand Down Expand Up @@ -47,7 +47,7 @@ There are other characteristics, that we can call **deep quality**.

Functional quality is not enough, or even satisfactory on its own as an
ambition. True excellence in documentation implies characteristics of quality
that are not included in accuracy, completeness and so on.
that are not included in accuracy, completeness, and so on.

Think of characteristics such as:

Expand All @@ -71,7 +71,7 @@ What's the difference?
Aspects of deep quality seem to be genuinely distinct in kind from the
characteristics of functional quality.

Documentation can meet all the demands of functional quality, and still fail
Documentation can meet all the demands of functional quality and still fail
to exhibit deep quality. There are many examples of documentation that is
accurate and consistent (and even very useful) but which is also awkward and
unpleasant to use.
Expand Down