From Fedora Project Wiki
m
(Add contributor, fix a typo and British to American English)
 
Line 1: Line 1:
{{admon/note| There is no documentation here. | This page is about planning and organising work on Fedora Server documentation.
+
{{admon/note| There is no documentation here. | This page is about planning and organizing work on Fedora Server documentation.
 
}}
 
}}
  
Line 10: Line 10:
 
* '''[[User:pboy | Peter Boy]]''' (pboy)  Author, Information Architect  
 
* '''[[User:pboy | Peter Boy]]''' (pboy)  Author, Information Architect  
 
* '''[[User:x3mboy | Eduard Lucena]]''' (x3mboy) Contributor
 
* '''[[User:x3mboy | Eduard Lucena]]''' (x3mboy) Contributor
 +
* '''[[User:copperi | Jan Kuparinen]]''' (copperi) Contributor
 
* more to add (hopefully)
 
* more to add (hopefully)
 
}}
 
}}
Line 17: Line 18:
 
= Goals =  
 
= Goals =  
  
* Build up a documetation which will be part of the fedora [https://docs.fedoraproject.org docs landing page (docs.fedoraproject.org)]
+
* Build up a documentation 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 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"]  
 
* Maybe: Additional information to the central [https://docs.fedoraproject.org/en-US/fedora/f33/install-guide/ "Installation Guide"]  
Line 23: Line 24:
 
= The next steps =
 
= The next steps =
  
* Concretisation of the planning. We need
+
* Concretization of the planning. We need
 
** a rough overall plan of the content
 
** a rough overall plan of the content
 
** exemplary topics / themes
 
** exemplary topics / themes
Line 40: Line 41:
  
 
=== Team ===
 
=== Team ===
We need skillsets from multiple roles 
+
We need skill sets from multiple roles 
  
 
* '''Authors/Writers''' with a deep understanding of the software being described, who create texts, of course
 
* '''Authors/Writers''' with a deep understanding of the software being described, who create texts, of course
Line 57: Line 58:
 
* Provide each step with a brief explanation/justification, if possible, a general instruction structure and a concrete example.
 
* Provide each step with a brief explanation/justification, if possible, a general instruction structure and a concrete example.
  
=== Overall Conceptualisation of Server Documentation Content ===
+
=== Overall Conceptualization of Server Documentation Content ===
  
 
As a first Draft we may discuss
 
As a first Draft we may discuss

Latest revision as of 08:53, 4 March 2021

Note.png
There is no documentation here.
This page is about planning and organizing work on Fedora Server documentation.
Idea.png
Server Documentation Team
Activists


Goals

The next steps

  • Concretization of the planning. We need
    • a rough overall plan of the content
    • exemplary topics / themes
    • to find contributors / authors
  • Set up Working Environment
    • Staging Area
    • Preparation of publishing pipelines
  • Define Milestones
    • Most important: minimum requirement for going online

Preliminary planning proposal

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.

Team

We need skill sets 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

Guidelines

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.

Overall Conceptualization of Server Documentation Content

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

  • Navigation Items
    • Home / Landing Page Fedora Server Documentation
    • Post-installation Procedures / Security Hardening
    • Fedora Server Example Use Cases
    • Tutorials
    • Trouble Shooting Guide / Known Issues
    • People, policies, and Working Methods
  • Details Home / Landing Page
  • Details Post Installation
  • Details Example Use Cases
  • Details Tutorials
  • Details People, Policies, ...