c94fc1ee60
The guidelines include information regarding: lists, modular writing, notices, parallelism and simple English. Also includes the capitalization, punctuation and spelling conventions for the project. Change-Id: I754f492db41dc5cc2432d03441b0526603b043e6 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
28 lines
903 B
ReStructuredText
28 lines
903 B
ReStructuredText
.. _detailed:
|
|
|
|
Detailed Writing Style Guidelines
|
|
#################################
|
|
|
|
Tone and audience
|
|
*****************
|
|
|
|
The tone of the |project|'s documentation should be clear, concise,
|
|
confident, and courteous. We are writing to peers, so we want to be
|
|
familiar. Use you, we and avoid the passive voice, but while remaining
|
|
professional. The writing should carry an undertone of cordiality,
|
|
respect, and cooperation.
|
|
|
|
Assume your audience is at about the same level of technical
|
|
understanding and expertise as you are. We don't want to talk down to
|
|
our readers. Do not assume the readers know everything about the
|
|
subject. Offer brief explanations or summaries of "common knowledge"
|
|
where you think a significant portion of readers might benefit.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
detailed_parallellism.rst
|
|
detailed_simple.rst
|
|
detailed_lists.rst
|
|
detailed_notices.rst
|
|
detailed_modular.rst |