Revision as of 17:01, 25 February 2021

There is no documentation here.
This page is about planning and organising work on Fedora Server documentation.

Server Documentation Team
Membership

Goals

Build up a documetation which will be part of the fedora docs landing page (docs.fedoraproject.org)
Maybe: Additional information to central "System Administrator's Guide" documentation
Maybe: Additional information to the central "Installation Guide"

Concretisation of the planning. We need
- a rough overall plan of the content
- exemplary topics / themes
- to find contributors / authors

Recently I came across an informative article: : "What is good documentation for software projects?" It's not brand new, but it's a good summary of what to look for in a documentation project.

We need skillsets from multiple roles

Authors/Writers with a deep understanding of the software being described, who create texts, of course
Information Architects who understands how to structure material
Reviewers with a deep understanding of the software being described, who ensure technical correctness
Editor/Reader, especially English native speakers, who proofread the wording and spelling
Administrator who keeps up the build pipelines and correct web formatting and presentation
Coordinator, who keeps an eye on the overall plan and helps to align all the processes and people

Notes on the structure of the texts. For example, it would be necessary to regulate:

Specification of author(s), date of creation, last update, Fedora version with which representations were tested.
Start with a short summary of the subject matter, objective and desired outcome. (paragraph of 2-3 sentences)
Divide longer sequences into sections with subheadings and short explanations
Provide each step with a brief explanation/justification, if possible, a general instruction structure and a concrete example.

As a first Draft we may discuss (See also: A first draft of a proposal for a concept to improve documentation)

@@ Line 9: / Line 9: @@
 '''Membership'''
 * '''[[User:pboy | Peter Boy]]''' (pboy)  Author, Information Architect
+* '''[[User:x3mboy | Eduard Lucena]]''' (x3mboy) Contributor
 * more to add (hopefully)
 }}
@@ Line 16: / Line 17: @@
 = Goals =
-* Build up a documetation which will be part of the fedora docs landing page (docs.fedoraproject.org)
+* Build up a documetation which will be part of the fedora [https://docs.fedoraproject.org docs landing page (docs.fedoraproject.org)]
 * Maybe: Additional information to central [https://docs.fedoraproject.org/en-US/fedora/f33/system-administrators-guide/ "System Administrator's Guide"] documentation
 * Maybe: Additional information to the central [https://docs.fedoraproject.org/en-US/fedora/f33/install-guide/ "Installation Guide"]