2015-09-03 19:12:59 -07:00
|
|
|
|
|
|
|
.. _stg_writing_style:
|
|
|
|
|
|
|
|
=============
|
|
|
|
Writing style
|
|
|
|
=============
|
|
|
|
|
|
|
|
This section describes general writing style guidelines that
|
|
|
|
documentation contributors should follow to ensure consistency
|
|
|
|
throughout all technical publications.
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
|
|
writing-style/general-writing-guidelines.rst
|
|
|
|
writing-style/word-choice.rst
|
2015-12-09 17:45:27 +02:00
|
|
|
writing-style/punctuation.rst
|
2016-04-02 17:06:55 +03:00
|
|
|
writing-style/headings.rst
|
2015-12-09 17:45:27 +02:00
|
|
|
writing-style/lists.rst
|
2017-01-17 17:18:00 +00:00
|
|
|
writing-style/urls.rst
|
2015-12-09 17:45:27 +02:00
|
|
|
writing-style/num_and_units_of_measure.rst
|
2015-09-03 19:12:59 -07:00
|
|
|
writing-style/openstack-components.rst
|
|
|
|
writing-style/release-names.rst
|
2015-11-13 16:03:19 +02:00
|
|
|
writing-style/ui-terminology.rst
|
2015-09-03 19:12:59 -07:00
|
|
|
writing-style/code-conventions.rst
|