michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: Edits to the about.rst and simple.rst files.

Browse source 
Book titles need italics, other minor issues Line length fixed.
Markup errors corrected.
Resubmitted to solve merge issues.

Change-Id: I069463a45655e1bd4c57828008c0868083757344
Signed-off-by: L.S. Cook <leonax.cook@intel.com>
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
This commit is contained in:
Rodrigo Caballero 2015-10-14 22:00:34 -05:00 • committed by Anas Nashif
commit ebbecd072b
2 changed files with 17 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

16
doc/collaboration/documentation/about.rst
View file

@ -24,19 +24,23 @@ Audience
This style guide has two audiences:
* Primary audience: Developers who author content that describes product function, code examples,
procedures and more. Guidelines apply to human and machine generated content, such as APIs.
* Primary audience: Developers who author content that describes product
function, code examples, procedures and more. Guidelines apply to human and
machine generated content, such as APIs.
* Technical writers that wish to create technical documentation for the |project| (writers).
* Technical writers that wish to create technical documentation for the
|project| (writers).
* Secondary audience: Developers that wish to document their code and features (authors).
* Secondary audience: Developers that wish to document their code and
features (authors).
Where the guideline makes a distinction for the two audiences, we will
refer to these groups as writers and authors.
.. note::
As secondary audience, developers are not expected to master the style and writing guidelines
in this document; it is available to them as a reference.
As secondary audience, developers are not expected to master the style and
writing guidelines in this document; it is available to them as a
reference.
Methodology
***********

14
doc/collaboration/documentation/simple.rst
View file

@ -112,14 +112,14 @@ Action Verbs vs. Nominalizations
Avoid nominalizations, which are nouns formed from verbs. For example:
===================== =====================
Verbs Nominalizations
Verbs Nominalizations
===================== =====================
complete completion
introduce introduction
provide provision
fail failure
arrange arrangement
install installation
complete completion
introduce introduction
provide provision
fail failure
arrange arrangement
install installation
===================== =====================
The problem with nominalizations is that they are often used instead of