User:Danielsmw/User Guide F11 tasks
Tasks currently target: Fedora 11 User Guide
About this Page
This page is for keeping track of tasks for the F11 guide. Since the F10 UG technically isn't done (since it hasn't been pushed to XML and it could still use some wordsmithing), this page will allow us to work on the F11 UG in parallel with the F10 UG (the task list for which can be found at https://fedoraproject.org/wiki/User_Guide_tasks). This page will be merged into the normal User_Guide_tasks page when necessary.
The task list below has four stages:
- Fact Check
- This stage just changes all factual information so that it syncs up with the facts for F11. If the default browser happens to be Dillo instead of Firefox for this release, the Fact Check stage should reflect this after completion.
- (Re)write Chapter
- This stage is for two things: re-fact checking and then editing the formatting and organization of sections so that it lines up with all of our conventions. This could mean anything from fixing headers to putting in admons (like the ones at the bottom of this page) to making sure that the standard installation process is referenced instead of including it inline.
- This is for the English majors. Make the page grammatically sound while keeping our conventions and a technical writing style in mind. Extra points go for stylizing the writing as long as it doesn't conflict with the core goals of readability and simplicity in comprehension.
- Edit Format/XML Conversion
- Somebody get this chapter into DocBook XML!
Notes to Contributors
Whenever we discuss an application not installed by default, we should put a note about having to install it. The note should look like this:
- To install the package claws-mail, read the chapter on managing software. You can install claws-mail by either using the PackageKit application or on the command line by using Yum. More information about Claws Mail is available at: http://claws-mail.org/.
Of course, this should be edited according to the application name, package name, and application home page, but try to use this template for consistency's sake.
- Also note that I just made this convention up, so don't feel like you should have known this before. If you have suggestions or comments, let me know.
--Danielsmw 15:08, 25 February 2009 (UTC)
Whenever we add something that would be nice to have in the user's guide but isn't necessary for the basic desktop user who just migrated fresh from Windows (example: discussion of FTP programs, advanced discussion of yum on the command line), we should add a template to let the confused user know not to worry about this section if they don't want to. This is what I've come up with right now:
That, again, is just my current idea until someone suggests or comments on that. Let me know in IRC or on the list. --Danielsmw 15:08, 25 February 2009 (UTC)
Sample: how to flag content
When flagging content that needs to be updated, include as much detail as you have available. Use this format to write a comment directly in the body of the content, in the location you are flagging as needing an update:
''Content needs updating: (write details of what needs updating here, followed by the special symbol that marks your comment with your username and timestamp.) ~~~~''