Re: Drafting the documentation page

Hi Dylan,

2010/12/2 Dylan Jay <dylan-Q+/Sk2sTzaxWk0Htik3J/[email protected]>

> On 31/10/2010, at 4:04 AM, Israel Saeta Pérez wrote:
>
>  Hey,
>>
>> Nicolas Vasseur has been working on a cleaner plone.org/documentation
>> page. Please check:
>>
>> http://plone.org/documentation/helpcenter_ploneorg2
>>
>> and tell us what you think. We want something clean and simple, pointing
>> to our best manuals, as agreed before, and with links to other sections
>> like the KB, error reference, faqs...
>>
>> Any comments appreciated!
>>
>
> very much clearer.
>
> One thing that perhaps could be made more clearer is that the "find
> documentation by topic" on the side bar.
>
> For instance if I click on "Installation" I get
> http://plone.org/documentation/phc_topic_area?topic=Installation
> which has the "Installing Plone" manual 3rd down the list. It does'nt
> really show that the manual is our "best effort" quality documentation and
> the others are user submitted.
>
>
I've starred it so it shows up now the first of its category. :)


> I'm not well versed on the cababilities of PHC but just off the top of my
> head are the following possible?
>
> - For each Topic on the side bar have "Manual" as first subtopic and have
> the manual underneath it?
>
> or
>
> - For each subtopic under a topic, e.g. Linux under Installation, have the
> first link be a to the appropriate chapter of the manual?
>
> other ideas?
>
>

Yes, the documentation by topic feature is broken right now. The
Installation, User, Theming, Development, and Community Development manuals
are already there. If we star them ("Start Here") they will show up first
for the appropiate topic. As I mentioned in another mail, I think we should
reduce the lists of topics to make it minimally useful.


> or are we just better off spending more time merging the kb items into
> manuals or removing them?
>
>
I don't think we could ever get this done. They're too many, and we want
everybody to manage the documents in the kb organically, not have us to do
all the merging work.

-- israel

------------------------------------------------------------------------------
Increase Visibility of Your 3D Game App & Earn a Chance To Win $500!
Tap into the largest installed PC base & get more eyes on your game by
optimizing for Intel(R) Graphics Technology. Get started today with the
Intel(R) Software Partner Program. Five $500 cash prizes are up for grabs.
http://p.sf.net/sfu/intelisp-dev2dev

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