[Feedhenry-raincatcher] Doc conventions

Wojciech Trocki wtrocki at redhat.com
Wed Oct 4 17:13:34 UTC 2017


Seems fine. I will try to collect all conventions we use and put them into
introduction so it will be easy for anyone to contribute to documentation.

On 4 Oct 2017 6:05 pm, "Paul Wright" <pwright at redhat.com> wrote:

Hi,

1. We're aiming docs to agree with the IBM Style guide (
https://drive.google.com/a/redhat.com/file/d/0B3Ir-
g6y8Qt8RmNqdU5Tb1VWdU0/view?usp=sharing).

2. Pages 129 to 137 outlines the use of highlighting.

3. I believe the following summarizes that text (from P134):
*Highlighting* *When to use*
No highlighting Most of the time.

4. With that in mind, most of my edits will remove highlighting.

thanks, Paul

As the guide says, use highlighting "sparingly so that it does not lose its
impact."

_______________________________________________
Feedhenry-raincatcher mailing list
Feedhenry-raincatcher at redhat.com
https://www.redhat.com/mailman/listinfo/feedhenry-raincatcher
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://listman.redhat.com/archives/feedhenry-raincatcher/attachments/20171004/25766eff/attachment.htm>


More information about the Feedhenry-raincatcher mailing list