summaryrefslogtreecommitdiff
path: root/docs/internals
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2015-12-29 11:22:51 -0500
committerTim Graham <timograham@gmail.com>2015-12-31 11:39:50 -0500
commitfd830ac8d93830c1cccf89d8fec854a9b47ddf4b (patch)
tree4e629d2e972cd7318f34855a89d9392915fabaad /docs/internals
parent313d54bd3c90eb649a01643c79b0af1d37fc281b (diff)
[1.9.x] Fixed #26003 -- Added "how the documentation is organized" sections.
Thanks Daniele Procida for coauthoring. Backport of df3d5b1d73699b323aac377dffab039dca26c1e4 from master
Diffstat (limited to 'docs/internals')
-rw-r--r--docs/internals/contributing/writing-documentation.txt51
1 files changed, 51 insertions, 0 deletions
diff --git a/docs/internals/contributing/writing-documentation.txt b/docs/internals/contributing/writing-documentation.txt
index f8e5b4f1a8..13bfe88290 100644
--- a/docs/internals/contributing/writing-documentation.txt
+++ b/docs/internals/contributing/writing-documentation.txt
@@ -65,6 +65,57 @@ Primer <sphinx:rst-primer>`. After that, you'll want to read about the
:ref:`Sphinx-specific markup <sphinx:sphinxmarkup>` that's used to manage
metadata, indexing, and cross-references.
+How the documentation is organized
+----------------------------------
+
+The documentation is organized into several categories:
+
+* :doc:`Tutorials </intro/index>` take the reader by the hand through a series
+ of steps to create something.
+
+ The important thing in a tutorial is to help the reader achieve something
+ useful, preferably as early as possible, in order to give them confidence.
+
+ Explain the nature of the problem we're solving, so that the reader
+ understands what we're trying to achieve. Don't feel that you need to begin
+ with explanations of how things work - what matters is what the reader does,
+ not what you explain. It can be helpful to refer back to what you've done and
+ explain afterwards.
+
+* :doc:`Topic guides </topics/index>` aim to explain a concept or subject at a
+ fairly high level.
+
+ Link to reference material rather than repeat it. Use examples and don't be
+ reluctant to explain things that seem very basic to you - it might be the
+ explanation someone else needs.
+
+ Providing background context helps a newcomer connect the topic to things
+ that they already know.
+
+* :doc:`Reference guides </ref/index>` contain technical reference for APIs.
+ They describe the functioning of Django's internal machinery and instruct in
+ its use.
+
+ Keep reference material tightly focused on the subject. Assume that the
+ reader already understands the basic concepts involved but needs to know or
+ be reminded of how Django does it.
+
+ Reference guides aren't the place for general explanation. If you find
+ yourself explaining basic concepts, you may want to move that material to a
+ topic guide.
+
+* :doc:`How-to guides </howto/index>` are recipes that take the reader through
+ steps in key subjects.
+
+ What matters most in a how-to guide is what a user wants to achieve.
+ A how-to should always be result-oriented rather than focused on internal
+ details of how Django implements whatever is being discussed.
+
+ These guides are more advanced than tutorials and assume some knowledge about
+ how Django works. Assume that the reader has followed the tutorials and don't
+ hesitate to refer the reader back to the appropriate tutorial rather than
+ repeat the same material.
+
Writing style
-------------