1
0
Fork 0
forked from docs/team-docs

style guide update

This commit is contained in:
hank L 2023-03-19 14:11:40 +00:00
commit b5ca7d6e41

View file

@ -1,7 +1,7 @@
= Contributing to Quick Docs
Peter Boy; Fedora Documentation Team
:revnumber: F36 and newer
:revdate: 2023-02-07
:revdate: 2023-03-19
[abstract]
@ -19,7 +19,7 @@ Fedora Quick Docs is especially a place for two types of articles
How-to::
Its characteristics are
* Intended to be useful when working with Fedora
* Characterized by a strict problem and goal orientation_
* Characterized by a strict problem and goal orientation
* It is usually a relatively short text, probably no longer than 60,000 characters
* Comes usually as a step-by-step instruction to resolve a small, specific problem or task, without extensive explanation
@ -39,7 +39,7 @@ Everyone can contribute and everyone is welcome! The only requirement is a FAS a
Typical roles/tasks are
* writer
* reviewer
* technical reviewer
* spell checking
* wording improvements
* QuickDoc organization
@ -50,10 +50,9 @@ Typical roles/tasks are
* General _Pull Requests_ (PR) workflow
* Either local authoring environment or page editor in Pagure user interface
== What to pay attention to?
* Readability (short sentences, structured into short paragraphs. visual guidance / visual structure, no "Pixel Wüste" (pixel desert, don't know the English term for massive, unstructured and therefore just hard to read pile of texts)
== What to pay attention to
* Readability: write short sentences, structured into short paragraphs. Use visual guidance and visual structure. Avoid the wall of text when creating content.
* Adherence to style guide: Refer to xref:contributing-docs/style-guide.adoc
== Article template