Skip to content

Make reference-explanation.rst more self-consistent #155

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

Make reference-explanation.rst more self-consistent #155

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
8 changes: 4 additions & 4 deletions reference-explanation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
The difference between reference and explanation
================================================

Explanation and reference both belong to the *theory* half of the Diátaxis map - they don't contain
Reference and explanation both belong to the *theory* half of the Diátaxis map - they don't contain
steps to guide the reader, they contain theoretical knowledge.

The difference between them is - just as in the difference between tutorials and how-to guides - the
difference between the *acquisition* of skill and knowledge, and its *application*. In other words
it's the distinction between *study* and *work*.
The difference between them is - just as in the difference between tutorials and how-to guides - that
reference is used in the *application* of skill and knowledge, whereas explanation is used for the
*acquisition* of skill and knowledge. In other words, it's the distinction between *work* and *study*.


A straightforward distinction, *mostly*
Expand Down