Re: IPFire Wiki Workflow

[Michael Tremer <michael.tremer@ipfire.org>]

[-- Attachment #1: Type: text/plain, Size: 3999 bytes --]

Hey Erik,

great that you are back from traveling and that we can finally go on
with this one.

On Sat, 2013-07-27 at 18:00 +0200, Erik K. wrote:
> Hi Michael,
> so for the first i think your workflow looks pretty good, but i have some possible enhancements how to extend this workflow. 
> - The developers and their new developments should become also a part of Point (A) i think. Stevee shows a good way how a short developer hand out could looks like, take a look in here --> http://wiki.ipfire.org/en/configuration/network/dnsforward . So the coordinator needs to know about this changes too that he can define a priority in the topics.

The idea is right, that developers should create a small page with the
most essential information about a new feature, but I don't see how this
is involved in the workflow of the documentation team.

I think we should work on an extra development workflow and at the end
of that, it should be mandatory to create that page and send the
information about the existence of that to the wiki coordinator.

Basically, this happens independently from the documentation workflow.

> - In point (B) shouldn´t be not also the german translations in there as a point (2) ?

No,  the idea is to write the content in English first. And after that
has been finished and been reviewed (C), we start translating.

I guess the translation teams will organize themselves in a way they
like. They are usually much smaller and do not need a lot of
coordination.

The workflow implies one very import thing: English first.
No content is ever created first in any other language than English.
After it has been reviewed, we start translations into second languages.

> - The testing of the written articles should be mentioned i think, cause it is not enough to understand what this software should do, the software needs to be tested in every single function so a quality management will be done too.

This should be part of the review.

> 	--> I think a new guideline for new and old wikis should be to explain every function which can be seen on the WUI, this means especially the core development or addons where a GUI was also developed by the IPFire team..
> 	--> Addons with foreign documentations can also become a short docu, but they should be linked to the external wiki/docu. This should also be a part of a guideline too.

To give a short answer on this: We should not copy content or write
articles about things that are not part of our business. Just link to
it.

We should discuss some general styling guidelines after we have proved
that the desired workflow is actually working.

> A question: Should i start as a coordinator to list some important topics ? Or do we need a little longer ?

This list should be open (as basically everything). I suppose it's best
to create an extra wiki page for that and write down what needs to be
done. In addition to that we should set a priority and write down notes
about what particularly needs to be improved on an article.

Here are two things that are due until the release of the next core
update, which will be roughly 2 weeks. Possibly less.

 * Wireless Client on RED
 * DNS Forwarding GUI

> 
> ------------------------
> 
> A guideline of how to structure the content and the layout of the wiki might be important for the workflow i think. This should prevent that people doing very different stuff if they work together in the same sections. So i have found until now 2 different guidelines for the IPFire wiki. 
> 
> - http://wiki.ipfire.org/nonpublic/en/guidelines
> - http://wiki.ipfire.org/en/edit
> 
> So some questions to you all regarding to this theme: 
> - What kind of layout and content structure we should use ? 
> - What things are missing in those guidelines ?
> - To make one good guideline please give some suggestions to them.

Let's discuss that later and let's focus on the content right now.

Best,
-Michael