Docs Style Guide

Gedare Bloom gedare at rtems.org
Thu Jul 18 15:32:33 UTC 2019


Reviewing the BB doc patch, I realized that we need a style guide for
writing docs [1].

We should start to collect Documentation Style notes in a wiki page,
and then push it to the docs [1]. If anyone has some initial set of
thoughts, it would be good to put them down in reply to this email.

My initial question on the BB patch is whether to incorporate the 80
char line limit or not.

[1] https://docs.rtems.org/branches/master/eng/users-manuals.html#documentation-style-guidelines

Gedare


More information about the devel mailing list