mwinters/docs-team-docs
1
0
Fork 0
forked from docs/team-docs
Code Pull requests Activity

Update style-guide with abstract

Browse source
This commit is contained in:
hank L 2023-04-21 21:55:54 +00:00
commit 83721847c1
1 changed files with 4 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

5
modules/ROOT/pages/contributing-docs/style-guide.adoc
View file

@ -1,8 +1,11 @@
= Fedora Documentation Style Guide
Fedora Documentation Team <https://discussion.fedoraproject.org/tag/docs>
2023-04-17
2023-04-21
:page-pagination:
[abstract]
This guide provides style guidelines and preferred term usage for the Fedora Linux Documentation. Docs team created this guide to strive for correctness and consistency in documentation.
== Writing style guide
Write clearly and use shorter sentences:: The longer a user documentation is, the more difficult it is to understand. Writing with brevity (to the point) is good. Clarity is better.