Re: Aw: Re: IPFire Wiki Workflow

* Re: IPFire Wiki Workflow
@ 2013-07-11 22:01 Michael Tremer
  2013-07-12 12:10 ` Aw: " Bernhard Bitsch
  0 siblings, 1 reply; 7+ messages in thread
From: Michael Tremer @ 2013-07-11 22:01 UTC (permalink / raw)
  To: documentation

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

Great thoughts, but let's bring down the pace a little bit before we
start talking about the actual content that needs to be reviewed and
possibly (re-written).

I am still aiming for defining a workflow in this discussion that should
be followed under all circumstance, because I think this is what is most
important on a team, that we are all on the "same page" (almost
literally in this context).

Central questions are:

* How do we attract authors? (People who write content)
* How do we attract translators? (People who translate the content from
English into their respective languages)
* How do we decide what to work on? When? For how long?

The has to be a "team", otherwise we don't need to think about the
content.

On your note about that development has to be involved in this as well:
Agreed and I already talked to Arne and Stevee how we can do that in the
least time consuming way, because we also don't have much time and loads
of things to work on.
Writing articles in more than one language is an absolute no-go. We will
leave it at English and write down the most important things one needs
to know about a certain add-on or what ever. Adding screenshots, doing
the translations and getting the article into a round shape should be
the task of the translation team. Could you guys agree on that?

I also think that developers are not the best people to write end-user
documentation. It is getting to complex and not suitable for beginners
any way.

-Michael

On Thu, 2013-07-11 at 19:30 +0200, Erik K. wrote:
> Hi all,
> regarding to the ideas causing a better overview of the wiki content, i have tried a more compressed layout of the configuration wiki. The actual (official) look of this section can be found in here --> http://wiki.ipfire.org/en/configuration/start . 
> The new one is very unready and only a first try, but it should show an idea how it could be better overviewed. 
> In here --> http://wiki.ipfire.org/en/configuration/start you belong to the new structure.
> Until now there is no content behind the structure but this should be done fast by a copy and paste of the old content. <-- Better to check out some sections before. Another possibility in this kind of structure can be to work more precised in themes with e.g. 5-10 different sections not as before with 40-50 (example in here --> http://wiki.ipfire.org/en/configuration/start ).
> 
> A statement to the wiki workflow:
> In the last months, mostly work was done in particular articles of the wiki, also to clean up the code cause a lot of plugins was replaced, so the general structure wasn´t touched but becomes more and more informations. I think most important is for the first
> 	* Find out a new structure which can be better overviewed (configuration and installation, ???).
> 	* Go for a checkout of the basic system articles (without addons) and find out the worse sections to make them better and clearer.
> 	* If old articles will be revised, the explained functions should also be tested.
> 	* Documentation should be a part of the development of software (and if it is only a short developer hand out) so a possible documentation "team" have it easier.
> 
> Also to overview the actual changes in the wiki needs to be checked. In here --> http://wiki.ipfire.org/start?do=recent a done list can be overviewed. If there was a change in german, it might be great to find it also in the english wiki. As more people looks in there as better it is.
> 
> The native speakers: It is very important to have some people especial in english (american/english). The best might be that some people are native in two languages german/english otherwise we have the same condition than before. I tried always my best as an native german speaker to translate the wikis into english, but thats not enough for a good feeling by reading. So i tried always to send some messages over the docu mailinglist with the please that someone can go for corrections (also in german). Sometimes this kind of workflow did it very good (thanks again Rod by the way ;-), but sometimes (especially in the last past months) there was no response. As time goes by the wiki articles leaves the memory that there was something to do and they where forgotten. So it is maybe an idea to mark those articles as "uncheck, everybody is invited to go for a revise" or something.
> 
> So for the first some ideas from me.
> 
> 
> Greetings 
> 
> 
> Erik
> _______________________________________________
> Documentation mailing list
> Documentation(a)lists.ipfire.org
> http://lists.ipfire.org/mailman/listinfo/documentation

^ permalink raw reply	[flat|nested] 7+ messages in thread