"Re: Contents of fedora-docs-list digest..."
Sarat sethy
saratsethy at hotmail.com
Thu Dec 14 05:15:42 UTC 2006
>From: fedora-docs-list-request at redhat.com
>Reply-To: fedora-docs-list at redhat.com
>To: fedora-docs-list at redhat.com
>Subject: fedora-docs-list Digest, Vol 34, Issue 14
>Date: Wed, 13 Dec 2006 12:00:31 -0500 (EST)
>
>Send fedora-docs-list mailing list submissions to
> fedora-docs-list at redhat.com
>
>To subscribe or unsubscribe via the World Wide Web, visit
> https://www.redhat.com/mailman/listinfo/fedora-docs-list
>or, via email, send a message with subject or body 'help' to
> fedora-docs-list-request at redhat.com
>
>You can reach the person managing the list at
> fedora-docs-list-owner at redhat.com
>
>When replying, please edit your Subject line so it is more specific
>than "Re: Contents of fedora-docs-list digest..."
>
>
>Today's Topics:
>
> 1. Re: Admin Guide / Accounts - call for feedback (Paul W. Frields)
> 2. Re: Admin Guide / Accounts - call for feedback (Vladimir Kosovac)
> 3. Re: Admin Guide / Accounts - call for feedback (Rahul Sundaram)
> 4. Re: Admin Guide / Accounts - call for feedback (Vladimir Kosovac)
> 5. IPv6 documentation (Peter Vrabec)
> 6. Re: IPv6 documentation (Rahul Sundaram)
>
>
>----------------------------------------------------------------------
>
>Message: 1
>Date: Tue, 12 Dec 2006 17:45:21 -0500
>From: "Paul W. Frields" <stickster at gmail.com>
>Subject: Re: Admin Guide / Accounts - call for feedback
>To: For participants of the Documentation Project
> <fedora-docs-list at redhat.com>
>Message-ID: <1165963521.15428.19.camel at localhost.localdomain>
>Content-Type: text/plain; charset="us-ascii"
>
>On Tue, 2006-12-12 at 05:36 -0800, Tommy Reynolds wrote:
> > Uttered "Paul W. Frields" <stickster at gmail.com>, spake thus:
> >
> > > On Mon, 2006-12-11 at 12:52 +0530, Rahul Sundaram wrote:
> > > > Vladimir Kosovac wrote:
> > > > > I have couple of sandboxed pages ready for your review/input at:
> > > > >
>http://fedoraproject.org/wiki/wiki/VladimirKosovac/StylingPage/WorkPage
> > > > For example, if I am doing web services administration, I would
>expect
> > > > to learn about system-config-httpd in that section along with the
>Apache
> > > > configuration details.
> > > That's an excellent point Rahul makes -- that our documentation should
> > > be largely task-based. Relevant material should be lumped together
> > > where possible and logical.
> >
> > Agree emphatically.
> >
> > What I detest is "feature-oriented" documentation that mostly walks
> > around the buttons and menus of a GUI, or is an elaborated bullet
> > list of each separate feature (even if the elaboration runs to pages
> > or chapters). I'm as guilty as anyone about doing this ("My name
> > is Tommy. Chorus: Hi, Tommy!") but I'm recovering ;-)
> >
> > Every button / menu / feature / asset was designed into the program to
> > provide a service, with a reason behind that decision. Document the
> > problem solved by the feature, et. al., and not the implementation.
> > Answer the question of "how do I foo", not the question "what do all
> > these buttons mean?"; then the "what are all these dials and switches"
> > question becomes moot.
> >
> > So, instead of this:
> >
> > o The FILE menu has an EXIT button.
> >
> > I'd prefer to see:
> >
> > o When you are finished, click the FILE/EXIT button to
> > save all your work and to gracefully terminate the
> > program.
> >
> > Just my $0.02e+27, YMMV.
>
>Yessirree! To harp on something (yet again), note how important this
>makes defining your audience and their core knowledge, skills, and
>abilities: Without that thatinformation, you can't tell what your
>audience can't do without in terms of instruction.
>
>--
>Paul W. Frields, RHCE http://paul.frields.org/
> gpg fingerprint: 3DA6 A0AC 6D58 FEC4 0233 5906 ACDB C937 BD11 3717
> Fedora Project Board: http://fedoraproject.org/wiki/Board
> Fedora Docs Project: http://fedoraproject.org/wiki/DocsProject
>-------------- next part --------------
>A non-text attachment was scrubbed...
>Name: not available
>Type: application/pgp-signature
>Size: 189 bytes
>Desc: This is a digitally signed message part
>Url :
>https://www.redhat.com/archives/fedora-docs-list/attachments/20061212/d416166f/attachment.bin
>
>------------------------------
>
>Message: 2
>Date: Wed, 13 Dec 2006 19:33:53 +1300
>From: Vladimir Kosovac <vnk at mkc.co.nz>
>Subject: Re: Admin Guide / Accounts - call for feedback
>To: For participants of the Documentation Project
> <fedora-docs-list at redhat.com>
>Message-ID: <457F9ED1.3090504 at mkc.co.nz>
>Content-Type: text/plain; charset="iso-8859-1"
>
>Paul W. Frields wrote:
> > On Tue, 2006-12-12 at 05:36 -0800, Tommy Reynolds wrote:
> >> Uttered "Paul W. Frields" <stickster at gmail.com>, spake thus:
> >>
> >>> On Mon, 2006-12-11 at 12:52 +0530, Rahul Sundaram wrote:
> >>>> Vladimir Kosovac wrote:
> >>>>> I have couple of sandboxed pages ready for your review/input at:
> >>>>>
>http://fedoraproject.org/wiki/wiki/VladimirKosovac/StylingPage/WorkPage
> >>>> For example, if I am doing web services administration, I would
>expect
> >>>> to learn about system-config-httpd in that section along with the
>Apache
> >>>> configuration details.
> >>> That's an excellent point Rahul makes -- that our documentation should
> >>> be largely task-based. Relevant material should be lumped together
> >>> where possible and logical.
> >> Agree emphatically.
> >>
> >> What I detest is "feature-oriented" documentation that mostly walks
> >> around the buttons and menus of a GUI, or is an elaborated bullet
> >> list of each separate feature (even if the elaboration runs to pages
> >> or chapters). I'm as guilty as anyone about doing this ("My name
> >> is Tommy. Chorus: Hi, Tommy!") but I'm recovering ;-)
>
>Am I understanding these suggestions well if I then say that tables on
>the intro page are redundant. To me, they look just like the stuff we
>want to avoid - feature listing for GUI tools - although more obscure.
>Scrap them, then?
>
>| vnk |
>
> >> Every button / menu / feature / asset was designed into the program to
> >> provide a service, with a reason behind that decision. Document the
> >> problem solved by the feature, et. al., and not the implementation.
> >> Answer the question of "how do I foo", not the question "what do all
> >> these buttons mean?"; then the "what are all these dials and switches"
> >> question becomes moot.
> >>
> >> So, instead of this:
> >>
> >> o The FILE menu has an EXIT button.
> >>
> >> I'd prefer to see:
> >>
> >> o When you are finished, click the FILE/EXIT button to
> >> save all your work and to gracefully terminate the
> >> program.
> >>
> >> Just my $0.02e+27, YMMV.
> >
> > Yessirree! To harp on something (yet again), note how important this
> > makes defining your audience and their core knowledge, skills, and
> > abilities: Without that thatinformation, you can't tell what your
> > audience can't do without in terms of instruction.
> >
> >
>
>
>-------------- next part --------------
>A non-text attachment was scrubbed...
>Name: signature.asc
>Type: application/pgp-signature
>Size: 251 bytes
>Desc: OpenPGP digital signature
>Url :
>https://www.redhat.com/archives/fedora-docs-list/attachments/20061213/0b1f0b5d/signature.bin
>
>------------------------------
>
>Message: 3
>Date: Wed, 13 Dec 2006 14:28:43 +0530
>From: Rahul Sundaram <sundaram at fedoraproject.org>
>Subject: Re: Admin Guide / Accounts - call for feedback
>To: For participants of the Documentation Project
> <fedora-docs-list at redhat.com>
>Message-ID: <457FC0C3.1060805 at fedoraproject.org>
>Content-Type: text/plain; charset=ISO-8859-1; format=flowed
>
>Vladimir Kosovac wrote:
> > Paul W. Frields wrote:
> >> On Tue, 2006-12-12 at 05:36 -0800, Tommy Reynolds wrote:
> >>> Uttered "Paul W. Frields" <stickster at gmail.com>, spake thus:
> >>>
> >>>> On Mon, 2006-12-11 at 12:52 +0530, Rahul Sundaram wrote:
> >>>>> Vladimir Kosovac wrote:
> >>>>>> I have couple of sandboxed pages ready for your review/input at:
> >>>>>>
>http://fedoraproject.org/wiki/wiki/VladimirKosovac/StylingPage/WorkPage
> >>>>> For example, if I am doing web services administration, I would
>expect
> >>>>> to learn about system-config-httpd in that section along with the
>Apache
> >>>>> configuration details.
> >>>> That's an excellent point Rahul makes -- that our documentation
>should
> >>>> be largely task-based. Relevant material should be lumped together
> >>>> where possible and logical.
> >>> Agree emphatically.
> >>>
> >>> What I detest is "feature-oriented" documentation that mostly walks
> >>> around the buttons and menus of a GUI, or is an elaborated bullet
> >>> list of each separate feature (even if the elaboration runs to pages
> >>> or chapters). I'm as guilty as anyone about doing this ("My name
> >>> is Tommy. Chorus: Hi, Tommy!") but I'm recovering ;-)
> >
> > Am I understanding these suggestions well if I then say that tables on
> > the intro page are redundant. To me, they look just like the stuff we
> > want to avoid - feature listing for GUI tools - although more obscure.
> > Scrap them, then?
>
>Like I said, that kind of information is better for reference when you
>do want to know a complete listing of the system configuration tools.
>Move it as a addendum.
>
>Rahul
>
>
>
>------------------------------
>
>Message: 4
>Date: Wed, 13 Dec 2006 22:59:49 +1300
>From: Vladimir Kosovac <vnk at mkc.co.nz>
>Subject: Re: Admin Guide / Accounts - call for feedback
>To: For participants of the Documentation Project
> <fedora-docs-list at redhat.com>
>Message-ID: <457FCF15.7010104 at mkc.co.nz>
>Content-Type: text/plain; charset="iso-8859-1"
>
>Rahul Sundaram wrote:
> >
> > Like I said, that kind of information is better for reference when you
> > do want to know a complete listing of the system configuration tools.
> > Move it as a addendum.
> >
> > Rahul
> >
>
>All done. Cheers,
>
>| vnk |
>
>-------------- next part --------------
>A non-text attachment was scrubbed...
>Name: signature.asc
>Type: application/pgp-signature
>Size: 251 bytes
>Desc: OpenPGP digital signature
>Url :
>https://www.redhat.com/archives/fedora-docs-list/attachments/20061213/f81b0744/signature.bin
>
>------------------------------
>
>Message: 5
>Date: Wed, 13 Dec 2006 17:05:56 +0100
>From: Peter Vrabec <pvrabec at redhat.com>
>Subject: IPv6 documentation
>To: fedora-docs-list at redhat.com
>Message-ID: <20061213170556.559462ea at wrabco.redhat.usu>
>Content-Type: text/plain; charset=US-ASCII
>
>Hi folks.
>
>I wrote an IPv6 documentation and I'd like to place on fedora wiki.
>But I'm little bit confused of current process, so I'm asking for help.
>I really like to do it as easy as possible. My naive vision is
>that somebody tell me were I can place link to my documentation
>and I'll do it that way. Of course I appreciate any asistence with
>this, since I'm not very experienced in wiki.
>
>I have an account and I'm in edit group and I hope I have all other
>stuff for that :-)
>
>thnx.
>
>
>
>
>
>
>
>
>
>------------------------------
>
>Message: 6
>Date: Wed, 13 Dec 2006 22:19:02 +0530
>From: Rahul Sundaram <sundaram at fedoraproject.org>
>Subject: Re: IPv6 documentation
>To: For participants of the Documentation Project
> <fedora-docs-list at redhat.com>
>Message-ID: <45802EFE.40104 at fedoraproject.org>
>Content-Type: text/plain; charset=ISO-8859-1; format=flowed
>
>Peter Vrabec wrote:
> > Hi folks.
> >
> > I wrote an IPv6 documentation and I'd like to place on fedora wiki.
> > But I'm little bit confused of current process, so I'm asking for help.
> > I really like to do it as easy as possible. My naive vision is
> > that somebody tell me were I can place link to my documentation
> > and I'll do it that way. Of course I appreciate any asistence with
> > this, since I'm not very experienced in wiki.
> >
> > I have an account and I'm in edit group and I hope I have all other
> > stuff for that :-)
>
>If you are planning to write a longer published guide, place it at
>http://fedoraproject.org/wiki/Docs/Drafts/. If you intend to keep it in
>the wiki might use the root namespace.
>
>Rahul
>
>
>
>------------------------------
>
>--
>fedora-docs-list mailing list
>fedora-docs-list at redhat.com
>https://www.redhat.com/mailman/listinfo/fedora-docs-list
>
>End of fedora-docs-list Digest, Vol 34, Issue 14
>************************************************
_________________________________________________________________
Don't miss the latest sporting action! If it's happening, it must be on MSN
Sports. Click to catch up! http://content.msn.co.in/Sports/Default
More information about the fedora-docs-list
mailing list