Hi Michael, thanks for the warm welcome.
Am 28.07.2013 um 18:27 schrieb Michael Tremer:
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.
My first idea was to find a way how the docu- and the developer group can work together to ensure that the communication flow is working. So i thought it might be an idea to illustrate this in the workflow too. But if the coordinator becomes informations about the existence of new development, may this enough too. I think also the addon developer needs also to be integrated in your above mentioned 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.
I think also, for the first the docu team is very small and for sure as time goes by, there will be a good way how to do it. So should the workflow be adjusted in point (D) with the german translation ? I think it is a good idea if we bring on the german translation also as a fix point, otherwise we can run in a reversed situation to now that the english parts will grow and the german part will hobbles afterwards. Or do we abolish the german wiki ?
- 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.
O.K. so part (C), should we adjust it in the workflow ?
--> 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.
O.K. good idea.
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.
Something like this --> http://wiki.ipfire.org/de/todo ? Please extend if you have some ideas.
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
DNS Forward in english is 80 % done in point (B), as i wrote in a previous mail.
Have tried to configure my system for wireless on red but i killed the machine, hopefully that someone else can go for this....
Erik
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.
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
Documentation mailing list Documentation@lists.ipfire.org http://lists.ipfire.org/mailman/listinfo/documentation