Re: Docs Workflow
Hello:
Like much of the Fedora wiki, this page is most useful if you already
know what's on it. I tried looking here when I was preparing my
proposal for Summer Coding, and it didn't help at all. Now that I
jumped in at the deep end, I recognize that there is a lot of important
information on this page.
How about...
--> renaming sections like "If you're working on a Guide," or "How
to
Prepare Release Notes"? Help readers find what they need.
--> adding an explanatory section describing things like "git" and
"docs-writers" once? This isn't bad on the current page, but it could
be more clear where the definitions are, and there could be more of them
that are not simply links elsewhere.
--> describing each process visually and textually? I like the
commonality between the images, but not everybody is a visual learner,
and we should take every opportunity to use both graphics and text.
I would have jumped in myself, but you requested feedback be posted to
the list.
Christopher.
On 08/27/2010 08:00 AM, docs-request(a)lists.fedoraproject.org wrote:
Subject: Docs Workflow
From: "John J. McDonough" <wb8rcr(a)arrl.net>
Date: Thu, 26 Aug 2010 08:50:37 -0400
To: docs(a)lists.fedoraproject.org
I've gotten back to working on the workflow page. My initial focus is
on getting resources for new beat writers. My approach here is to label
the various arrows on the diagrams, and then link to other pages with
additional input. There are a lot of resources out there, but newer
contributors don't know where they are, and more experienced
contributors forget about them. Hopefully we can ultimately provide a
useful index to the various resources.
** NEWER CONTRIBUTORS **
We are just getting started with this, so it will be easy for you to
influence the direction we take here. Please head over to
https://fedoraproject.org/wiki/Docs_Project_workflow
follow some of the links (right now the beat writing is in flux, so help
there would be especially welcome). Consider whether this is helpful
and post your comments to this list.
** EXPERIENCED CONTRIBUTORS **
https://fedoraproject.org/wiki/Docs_Project_Style_Guide looks like it
hasn't been touched in over a year. You might consider whether this
needs some tweaking.
Also, I will be focusing on the release notes section of the workflow
initially. If you can contribute to the Guides, Announcements or
Permissions sections, please dive in!
--McD