Documentation. Is the wiki a bit confusing?

Swift Mailer is a fantastic library for sending email with php. Discuss this library or ask any questions about it here.

Moderators: Chris Corbyn, General Moderators

Post Reply
User avatar
Chris Corbyn
Breakbeat Nuttzer
Posts: 13098
Joined: Wed Mar 24, 2004 7:57 am
Location: Melbourne, Australia

Documentation. Is the wiki a bit confusing?

Post by Chris Corbyn »

I'm in the middle of mucking about in the website's svn repository converting the whole thing to use symfony and basically spring cleaning a bit so that, well, I wouldn't be embarassed to allow other's access to the website source if ever the project picks up new developers :oops:

Anyway, I'm sure anyone who was using the library during the change from v2 to v3 would have noticed the move to dokuwiki for documentation. I'm not really feeling that dokuwiki is working out all that great but I was just wondering what the general opinion is. I'd prefer something a bit more integrated with the rest of the site (*cough* adsense revenue has alaso dropped to like, ermm, 1% of what it was when docs were part of the site :P) and a little easier to lay out the way I want it. I was thinking of building a (basic) documentation module in symfony with <tip>, <code>, <note> etc tags to do what I want and actually look a bit more aesthetically pleasing than dokuwiki - with a PDF download option if I can get things flowing a bit more "book" like. I'm not bothered about all the "revision" control of a wiki and auto-page-linking etc. just something that's easy to click "edit" and make changes.

I'm rambling on (seem to have a habit of this recently!) so I'll get to the point. Is it worth it, from your, as a user's point of view? :)

The obvious drawbacks of changing (yet again) are SEO and totally confusing people who've only just gotten used to the fact I switched to the wiki.
User avatar
Luke
The Ninja Space Mod
Posts: 6424
Joined: Fri Aug 05, 2005 1:53 pm
Location: Paradise, CA

Post by Luke »

Personally, I liked the documentation as part of the site a lot better. It was cleaner, easier to read, and it looked really good. I think the symfony idea is good.
User avatar
Chris Corbyn
Breakbeat Nuttzer
Posts: 13098
Joined: Wed Mar 24, 2004 7:57 am
Location: Melbourne, Australia

Post by Chris Corbyn »

Thanks, that's useful. I have to admit, I'm not happy with the documentation myself. The content's there, but the "flow" is awful.
User avatar
s.dot
Tranquility In Moderation
Posts: 5001
Joined: Sun Feb 06, 2005 7:18 pm
Location: Indiana

Post by s.dot »

It's probably just in your head man :P I can't really think of any documentation that has good flow.
Set Search Time - A google chrome extension. When you search only results from the past year (or set time period) are displayed. Helps tremendously when using new technologies to avoid outdated results.
User avatar
Luke
The Ninja Space Mod
Posts: 6424
Joined: Fri Aug 05, 2005 1:53 pm
Location: Paradise, CA

Post by Luke »

I'm looking at the documentation again, and now that I think about it, and while I agree that the flow isn't perfect, it's not bad either. I would say that it doesn't need to be a priority. I can find what I'm looking for reasonably fast, so I wouldn't take time you would have used to work on the library or documentation (text) and use it to work on the "flow". It is easy enough. :D
User avatar
Chris Corbyn
Breakbeat Nuttzer
Posts: 13098
Joined: Wed Mar 24, 2004 7:57 am
Location: Melbourne, Australia

Post by Chris Corbyn »

:) Well, I'm sort of juggling between working on the library (new release coming out later tonight) and creating the new site. Incidentally I've already made a start on the wiki-style documentation manager.
User avatar
Oren
DevNet Resident
Posts: 1640
Joined: Fri Apr 07, 2006 5:13 am
Location: Israel

Post by Oren »

Check your PM box d11wtq.
Post Reply