Skip to content

Commit

Permalink
Update diataxis.md
Browse files Browse the repository at this point in the history
minor edits
  • Loading branch information
curfman authored Dec 19, 2024
1 parent db06c46 commit 42d2ab2
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions CuratedContent/diataxis.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Diátaxis: A systematic approach to technical documentation authoring.
## Diátaxis: A Systematic Approach to Technical Documentation Authoring

<!--- deck text start --->
Diátaxis provides a framework for thinking about how to structure the content, style and
Diátaxis provides a framework for thinking about how to structure the content, style, and
organization for technical documentation.
<!--- deck text end --->

Expand All @@ -28,12 +28,12 @@ horizontally, and *Action* to *Cognition* vertically. The four documentation fo
four quadrants of the grid: Learning (with tutorials), How-To Guides (with goals), Information (with
technical references) and Understanding (with explanations). This visual model helps clarify the
purpose of each documentation type. For example, how-to guides fall into the second quadrant,
characterized by content focused on practical action and application. In addition to end-users,
this framework provides value to documentation creators and maintainers as it helps them identify
characterized by content focused on practical action and application. In addition to aiding end-users,
this framework provides value to documentation creators and maintainers, as it helps them identify
where within this structure new or updated information needs to be added.

In practice, documentation authoring is a challenging task. Having the Diátaxis structure in mind
can help clarify which of the content form a particular idea might best fit into; instead of
can help clarify into which of the content forms a particular idea might best fit; instead of
force-fitting all documentation in a single manual. Certain concepts, though, can be difficult to
categorize and might fit into multiple locations on the Diátaxis grid. So, like many tools and
processes, this approach doesn't eliminate the complexity of technical work but provides a
Expand Down

0 comments on commit 42d2ab2

Please sign in to comment.