[dokuwiki-teams] Re: Procedure for distribute the new pluginpage structure?

  • From: "Luis Machuca B." <ryan.chappelle@xxxxxxxx>
  • To: dokuwiki-teams@xxxxxxxxxxxxx
  • Date: Thu, 28 Oct 2010 20:10:01 -0300

Michael Klier escribió:
> On 27 October 2010 08:56, Matthias Schulte <mailinglist@xxxxxxxxx> wrote:
>> Morning,
>>
>> http://www.dokuwiki.org/teams:plugin_homepages
>>
>> What would be the approach to get this page structure to the current
>> existing plugin pages?
>>
>> We should start with pages where the author isn't present (or with low
>> editing rates) and then go on...
> 
> I took the liberty to add a FAQ section before the discussion section. 
> Questions
> from the discussion section wich are FAQ-worthy (i.e. how do I change
> CSS colors,
> or other stuff) should be refactored as FAQ entry. This way we omit
> long discussions
> and reoccuring questions on plugin pages.
> 
> Cheers,
> Michael
> 
> P.S.: Excuse my low signal:silence ratio at present. I'm currently
> trying to find a good schedule
> to take part in all team related stuff.
> 
> 

I think the overall idea for the plugin pages is good, but I don't think
everything should be a top-header. It tends to clutter things too much, and
from a practical persperctive not everythin is equally important; for
example, do we really need the "install via the plugin manager" text to be
as equally important as the configuration instructions in all pages?

I would separate three top headers: Installation and Usage, FAQ and extra
information (ie.: customization, common problems), and Discussion (if it is
not moved to another page). For each of these, set up the req   uired
subheaders, with at most one extra sublevel. It tends to keep related things
together and focus on usage patterns (ie.: if you want to use the plugin,
you'll want to know what to configure before; if you are detecting issues,
you'll want to know what issues are already registered).

For example, I am resetting up my plugin pages this way -- but of course
I'll change them to the standard that comes out from this discussion.

Just adding my ¢2, since I'm not as active as I would hope to otherwise.


-- 
----
Luis Machuca Bezzaza
Secretario (S) GULIX - Grupo de Usuarios de GNU/Linux de la IX Región
http://www.gulix.cl/
----

Other related posts: