how can I help?

Paul W. Frields stickster at gmail.com
Mon Jul 20 21:55:26 UTC 2009


On Mon, Jul 20, 2009 at 03:28:18PM -0400, Ricky Zhou wrote:
> On 2009-07-20 12:02:16 PM, Adam Williamson wrote:
> > I hate to be a stop-energy-spreader, but I'm not a big fan of the 'ten
> > thousand tiny pages' school of documentation. It winds up with two major
> > drawbacks: you can't ever find anything, and nothing gets updated.
> > (Visit the Gentoo wiki to observe both in operation).
> I think prioritizing documentation can help with this.  For example,
> a list of wiki pages/things that absolutely most be updated every
> release (does anything like this currently exist?)
> 
> I hate to keep picking on these few points, and this is not meant to put
> down our docs in any way, but I think the issue of
> 
> http://docs.fedoraproject.org/install-guide/f11/en-US/html/
> 
> vs.
> 
> http://en.opensuse.org/INSTALL_Local
> http://en.opensuse.org/Installation/11.1_Live_CD
> 
> is a very serious one.  Our organized, comprehensive docs definitely
> have their place, but the unfortunate fact is that some new users will
> be scared off by the table of contents alone.  This is where specific,
> task-based documentation (with an eye towards the defaults) is very useful.

How much could we avoid that scare by tuning the table of contents to
look more like what you see in the corner of a yelp screen?  I.e.,
chapter titles only, with a more detailed listing at the beginning of
the chapter itself?  This doesn't solve everything, but incremental
steps help.

-- 
Paul W. Frields                                http://paul.frields.org/
  gpg fingerprint: 3DA6 A0AC 6D58 FEC4 0233  5906 ACDB C937 BD11 3717
  http://redhat.com/   -  -  -  -   http://pfrields.fedorapeople.org/
  irc.freenode.net: stickster @ #fedora-docs, #fedora-devel, #fredlug




More information about the fedora-docs-list mailing list
https://listman.redhat.com/archives/fedora-docs-list/2009-July/010879.html
listman.redhat.com
crawl=CC-MAIN-2022-27
5035
application/http; msgtype=response
sha1:HBHX5M74I5MFAAC7IFPJ52P25UYQHRN3
<urn:uuid:2bb0fd2a-e5ad-4b4f-8bd5-3a54ee25f3d9>
2022-06-29T20:00:29Z
104.95.243.88
text/html
sha1:FV2ZCGLUD7XW3ASR2GE3LVX3WCSTDI2G
<urn:uuid:2677a11f-41a7-4853-8ee6-3aed310f3e19>
https://listman.redhat.com/archives/fedora-docs-list/2009-July/010879.html
response
<urn:uuid:1e48bfee-a398-40af-979e-10c3e1c7dae5>
isPartOf: CC-MAIN-2022-27
publisher: Common Crawl
description: Wide crawl of the web for June/July 2022
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-67-67-180
software: Apache Nutch 1.18 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.3-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: https://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/