View unanswered posts    View active topics

All times are UTC - 6 hours





Post new topic Reply to topic  [ 36 posts ] 
Go to page Previous  1, 2, 3

Print view Previous topic   Next topic  
Author Message
Search for:
 Post subject:
PostPosted: Wed Mar 22, 2006 12:06 pm 
Offline
Joined: Mon Oct 06, 2003 10:38 am
Posts: 4978
Location: Nashville, TN
no unfortunately the autogenerated list has no way of including a description, however I was planning on moving the Howto page over, it's just that it's getting so long now that it's hard to find things on, which I think a good list of categories should help with.

I don't know about rolling the FAQ in with the wiki. I kinda like it where it is now. I know I need to update it more often, and I plan on a big upgrade when 5.0 is released, and I can add administrators to help maintain it. My fear is if everyone can change it is that it will be flooded with hundreds of questions that are not FAQ Frequiently Asked Questions. I get tons of one off questions sent into the FAQ now, and if you get it overloaded with questions that only apply to a very small number of people it becomes too difficult to navigate.

I do plan on having a Troubleshooting category. It is just not there yet as there is not a page that links to it yet. I guess I need to create a page that is just a list of categories so that they will all show up. I have a list in my mind.

_________________
Have a question search the forum and have a look at the KnoppMythWiki.

Xsecrets


Top
 Profile  
 
 Post subject:
PostPosted: Wed Mar 22, 2006 2:15 pm 
Offline
Joined: Wed Dec 21, 2005 1:14 pm
Posts: 145
Location: Charlotte NC USA
I think if there were templates/formats for the HOW TOs it might help as time goes on. It would keep all the documents similar in structure and remind people to include all the important information.

This is just an idea of what I'm thinking I'm sure we could make a better style.

<Example>

How to Name
Aurther Name /Forum Name
Date written
Software version used
Hardware used

Version that have been tested (modification to the procedure below)
Version that have been tested (modification to the procedure below)

HowTo documented steps

Step 1 (what is this step doing)
#command to perform

Step 2 (what is this step doing)
#Command to perform

End of original How to


Version revisions
Aurther/Forum Name
Version

Step to modify

Step to modify

</example>


Top
 Profile  
 
 Post subject: Categories
PostPosted: Wed Mar 22, 2006 2:40 pm 
Offline
Joined: Mon Nov 28, 2005 10:44 am
Posts: 137
Location: Austin, TX
Since pages (articles?) can have multiple categories, you don't really need to worry so much about overlapping category scopes. So, you could have a lot of categories. With that in mind, I scanned the current wiki and here's what I came up with:

    - Remote Controls
    - Audio Configuration
    - Video Configuration
    - Networking
    - Video Capture Cards
    - Video (Out) Cards
    - Knoppmyth
    - Exporting Video
    - Non-US
    - Remote Access
    - Linux
    - Tweaks
    - Maintenance
    - Hard Dives
    - Myth Music
    - Myth Weather
    - (etc. for all plugins)


That may be too many... Or not enough...


Paul


Top
 Profile  
 
 Post subject:
PostPosted: Wed Mar 22, 2006 11:44 pm 
Offline
Joined: Mon Oct 06, 2003 10:38 am
Posts: 4978
Location: Nashville, TN
well I had looked over it and had a list very similar, and I think it's good. I understand we can have many categories, but if we make too many it just confuses and complicates things again. I don't think we need one for each plugin as most of them only have one page telling what they do. pretty much all the rest of yours was on my list as well. I guess I just need to create an IgnoreMe page or something and go ahead and create all the category links, so we can see and discuss them better.

Ok I've updated the category page. Most of them just point to a page called IgnoreMe, but it should give a better Idea of what I had in mind.

_________________
Have a question search the forum and have a look at the KnoppMythWiki.

Xsecrets


Top
 Profile  
 
 Post subject:
PostPosted: Thu Mar 23, 2006 1:24 am 
Offline
Joined: Thu Mar 25, 2004 11:00 am
Posts: 9551
Location: Arlington, MA
The frst thing that occurs to me in looking at this is that we need to cut as much jargon from the category names as we can, and make it screamingly obvious what each is about. A lot of the people looking at this are not going to have the first clue what LIRC is. And even I'm not sure what "Scripts" is for. Does it describe existing existing intalled scripts? (like cd_link.sh or install-nvidia-debian.sh) Does it contain useful add on scripts? Does it (less likely) tell you how to write scripts? We really don't want a repeat of Cecil having to battle to keep people who can't be bothered to read the sticky posts from flooding "Installation" with every dumb question that occurs to them.

Secondly I would lean towards a more functional breakdown, and fewer topics. Maybe something like:

Before you start - Things you need and need to know
Installing and upgrading KnoppMyth
Customization and localization
Troubleshooting your system
Using your system
External resources (Links to other sites)

I'd start every section with a brief blurb on what it was, what it wasn't, and where to look for related information ("Installation is about the install process proper. It is not about post install configuration or customization. For add on packages see the Customization section. For more infomation on resolving problems with your install/upgrade see the Troubleshooting section.")

Obviously there are some grey lines. Does verifying your CD image belong under Installing or under Troubleshooting?

Anyway that's my 2 cents...


Top
 Profile  
 
 Post subject:
PostPosted: Thu Mar 23, 2006 11:53 am 
Offline
Joined: Mon Oct 06, 2003 10:38 am
Posts: 4978
Location: Nashville, TN
Well For the scripts category what I was thinking about was a few people maintain scripts that do different things mostly addons. And they upload the scripts to the wiki. I guess it's rather vague because I didn't really know how to be specific in under 3 to 5 words.

I like the idea of putting a description at the top of each category page, and that is very easy to do.

The reason I was trying to use more categories rather than fewer was to try to avoid the problem we have right now where you go to the howto page and there are 100 pages which makes it harder to find the one you are looking for. And a page can be in multiple categories, so that should sort out some of the gray area you were talking about.

I would definitely like to make it as easy as possible for newbies to find the information they need. I don't think we'll have nearly as much of a problem with things going in the wrong category as the wiki is not really a question place, and thus generally draws more experienced users (not that this always means a lot :wink: ) I'm going to have to do a little digging, as I have it setup to space WikiWords, but it doesn't seem to follow the convention in the Categories. I'll have to ask on the dev list if there is an easy way to fix this. It would definitely make it easier to read if we have longer more descriptive categories.

_________________
Have a question search the forum and have a look at the KnoppMythWiki.

Xsecrets


Top
 Profile  
 

Display posts from previous:  Sort by  
Post new topic Reply to topic  [ 36 posts ] 
Go to page Previous  1, 2, 3



All times are UTC - 6 hours




Who is online

Users browsing this forum: No registered users and 26 guests


You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot post attachments in this forum

Jump to:  
Powered by phpBB® Forum Software © phpBB Group

Theme Created By ceyhansuyu