Unifying How to ask help guides

[Mikko Ohtamaa]

There are two how to ask help guides:

http://plone.org/documentation/how-to/asking-for-help

http://plone.org/documentation/how-to/ask-for-help/

and one, often related, troubleshooting guide:

http://plone.org/documentation/how-to/diagnosing-third-party-product-installation-problems/

I think these three could be unified.

Few ideas:

- Cut away "fluffy" speak without details, because it is not helping the user

- Write asking help story for support forms and IRC

- Go deep enough in details so that the developers can actually answer the problem (how to extract log files, how to run buildout in verbose mode)

[Israel Saeta Pérez]

Hi Mikko,

Yes, I agree we should try to unify these two first guide and portions of the third into one document, to avoid information scattering.

Do you have time to work on this? You can merge them all into another doc and later we can move its contents to the "asking-for-help" or "ask-for-help" docs, whichever we decide has a "better" naming.

Thanks for the heads up!

-- israel

On Fri, Jun 26, 2009 at 6:16 PM, Mikko Ohtamaa wrote:

There are two how to ask help guides:

http://plone.org/documentation/how-to/asking-for-help

http://plone.org/documentation/how-to/ask-for-help/

and one, often related, troubleshooting guide:

http://plone.org/documentation/how-to/diagnosing-third-party-product-installation-problems/

I think these three could be unified.

Few ideas:

- Cut away "fluffy" speak without details, because it is not helping the
user

- Write asking help story for support forms and IRC

- Go deep enough in details so that the developers can actually answer the
problem (how to extract log files, how to run buildout in verbose mode)




--
View this message in context: http://n2.nabble.com/Unifying-How-to-ask-help-guides-tp3162393p3162393.html
Sent from the Documentation Team mailing list archive at Nabble.com.


------------------------------------------------------------------------------
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs

------------------------------------------------------------------------------

_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs

[Alexander Limi]

Also remember that we have redirects, so whenever a piece of documentation  
is removed, we should redirect the old URL to the new one.

On Fri, 26 Jun 2009 10:52:23 -0700, Israel Saeta Pérez  
<[hidden email]> wrote:

> Hi Mikko,
>
> Yes, I agree we should try to unify these two first guide and portions of
> the third into one document, to avoid information scattering.
>
> Do you have time to work on this? You can merge them all into another doc
> and later we can move its contents to the "asking-for-help" or
> "ask-for-help" docs, whichever we decide has a "better" naming.
>
> Thanks for the heads up!
>
> -- israel
>
>
> On Fri, Jun 26, 2009 at 6:16 PM, Mikko Ohtamaa wrote:
>
>>
>> There are two how to ask help guides:
>>
>> http://plone.org/documentation/how-to/asking-for-help
>>
>> http://plone.org/documentation/how-to/ask-for-help/
>>
>> and one, often related, troubleshooting guide:
>>
>>
>> http://plone.org/documentation/how-to/diagnosing-third-party-product-installation-problems/
>>
>> I think these three could be unified.
>>
>> Few ideas:
>>
>> - Cut away "fluffy" speak without details, because it is not helping the
>> user
>>
>> - Write asking help story for support forms and IRC
>>
>> - Go deep enough in details so that the developers can actually answer  
>> the
>> problem (how to extract log files, how to run buildout in verbose mode)
>>
>>
>>
>>
>> --
>> View this message in context:
>> http://n2.nabble.com/Unifying-How-to-ask-help-guides-tp3162393p3162393.html
>> Sent from the Documentation Team mailing list archive at Nabble.com.
>>
>>
>>
>> ------------------------------------------------------------------------------
>> _______________________________________________
>> Plone-docs mailing list
>> [hidden email]
>> https://lists.sourceforge.net/lists/listinfo/plone-docs
>>

--
Alexander Limi · http://limi.net


------------------------------------------------------------------------------
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs

[Mikko Ohtamaa]

Israel Saeta Pérez wrote:

Do you have time to work on this? You can merge them all into another doc
and later we can move its contents to the "asking-for-help" or
"ask-for-help" docs, whichever we decide has a "better" naming.

Since this is quite low hanging fruit, I'd hope somebody else could pick it and I could focus on more technical documentation.

Cheers,
Mikko

[Israel Saeta Pérez]

Mikko Ohtamaa wrote:

>
>
> Israel Saeta Pérez wrote:
>>
>> Do you have time to work on this? You can merge them all into another doc
>> and later we can move its contents to the "asking-for-help" or
>> "ask-for-help" docs, whichever we decide has a "better" naming.
>>
>
> Since this is quite low hanging fruit, I'd hope somebody else could pick it
> and I could focus on more technical documentation.
>

Cool. I've created a new ticket and tagged it with the "newbie" keyword:
https://dev.plone.org/plone/ticket/9342

If anybody is interested on that, just comment the ticket or contact me
directly. Thanks!

-- israel


------------------------------------------------------------------------------
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs