A reminder to writers

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Within our documentation, we do not like to over use the word "see" as
this can be an uncomfortable reminder to visually impaired readers.  It
is especially challenging in the Release Notes as almost every other
paragraph tends to refer the reader to an external link.  The result is
paragraph after paragraph of "for details see ..." or "for more
information see ...".

Instead of "see", it is preferable to use terms like "refer to", "may be
found at" or other terms that do not imply a particular way of reading.
When referencing some user-visible change, exchange terms like "users
will see improved performance" for phrases like "users will notice
improved performance".

Simply being alert to this also helps make the prose a little less
repetitive.

Thanks
--McD


-- 
docs mailing list
docs@xxxxxxxxxxxxxxxxxxxxxxx
To unsubscribe:
https://admin.fedoraproject.org/mailman/listinfo/docs





[Index of Archives]     [Fedora Users]     [Fedora Desktop]     [Red Hat 9]     [Yosemite News]     [KDE Users]

  Powered by Linux