Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
67 changes: 61 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,65 @@
The documentation system
========================
Diátaxis Documentation Framework
================================

A comprehensive and practical system that can help maintainers of product documentation.
A systematic approach to creating better documentation.

Published at https://diataxis.fr
Diátaxis is a structured framework that helps you build clear, useful, and user-focused documentation.
It organises content into four distinct types:

Author: Daniele Procida
- **Tutorials** – Learning-oriented: *"I’m new, show me how."*
- **How-To Guides** – Problem-oriented: *"I know what I want to do, show me how to do it."*
- **Reference** – Information-oriented: *"Just the facts."*
- **Explanation** – Understanding-oriented: *"Help me understand this."*

License: `CC-BY-SA 4.0 <https://creativecommons.org/licenses/by-sa/4.0/>`_
This separation removes ambiguity in documentation and helps users find the right information at the right time.

Why Use Diátaxis?
-----------------

- ✍️ **Improves Clarity** – Avoids mixing intentions in documentation.
- 🧭 **User-Centred** – Meets different user needs at different stages.
- 🛠 **Easy to Apply** – No special tooling or frameworks required.
- 🌍 **Battle-Tested** – Used by organisations like Cloudflare, Vonage, and more.

Get Started
-----------

- Visit the official site: https://diataxis.fr/
- Read the quick primer: https://diataxis.fr/start-here/
- Use the Diátaxis Compass to review your docs: https://diataxis.fr/compass/

Repository Contents
-------------------

This repository contains the content and source for the Diátaxis website, including:

- Sphinx configuration and build scripts
- reStructuredText (.rst) files for all pages
- Image and diagram assets

Contributing
------------

Contributions are welcome!

If you have improvements, suggestions, or new ideas, please:

- Submit a pull request: https://github.com/evildmp/diataxis-documentation-framework/pulls
- Start a topic in the Discussions section: https://github.com/evildmp/diataxis-documentation-framework/discussions

Community & Support
-------------------

Want to connect with other Diátaxis users?

- Join the `#diataxis` channel on the Write the Docs Slack: https://www.writethedocs.org/slack/
- Engage via GitHub Discussions: https://github.com/evildmp/diataxis-documentation-framework/discussions

Whether you're adopting the framework for a single project or a whole organisation, the community is a great resource for feedback and advice.

License
-------

This work is licensed under the
Creative Commons Attribution-ShareAlike 4.0 International License:
https://creativecommons.org/licenses/by-sa/4.0/
8 changes: 4 additions & 4 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
alabaster==0.7.13
Babel==2.9.1
beautifulsoup4==4.10.0
certifi==2022.12.7
certifi>=2022.12.7
charset-normalizer==2.0.10
colorama==0.4.4
colorama>=0.4.5
docutils==0.20.1
furo==2023.9.10
idna==3.3
Expand All @@ -17,7 +17,7 @@ pyenchant==3.2.2
Pygments==2.17.2
pyparsing==3.0.6
pytz==2021.3
requests==2.27.1
requests>=2.27.1
six==1.16.0
snowballstemmer==2.2.0
soupsieve==2.3.1
Expand All @@ -34,5 +34,5 @@ sphinxcontrib-qthelp==1.0.3
sphinxcontrib-serializinghtml==1.1.5
sphinxcontrib-spelling==7.3.2
tornado==6.1
urllib3==1.26.8
urllib3>=1.26.8
zipp==3.7.0