Post Reply  Post Thread 
FAQ - Writers needed!
Author Message
openstream
Newbie
*


Posts: 9
Group: Registered
Joined: Nov 2006
Status: Offline
Reputation: 0
Post: #11
RE: FAQ - Writers needed!

I'm afraid, but I think you missed the point. I didn't want to make the case for or against TYPO3. This here is about documentation, isn't it? What could be easier to use than an open document template (XML) to create documentation that can be reused in many ways, i.e. to convert to HTML for displaying on a website, to convert to PDF for offline reading, etc.
If you don't like TYPO3 we can use the generic class mentioned above.
The main point is about providing a good base to inspire the community to create documentation. And you can see that the TYPO3 community is a great success in this regard.


Unfortunately, no one can be told what the Matrix is. You have to see it for yourself.
12-01-2006 08:31 AM
Visit this user's website Find all posts by this user Quote this message in a reply
MicCo
Junior Member
****
Dev Team

Posts: 213
Group: Dev Team
Joined: Oct 2006
Status: Offline
Reputation: 2
Post: #12
RE: FAQ - Writers needed!

I'm not against your suggestion, I just made a point to keep in mind!

Nothing to do with TYPO3 in that manner, but as stated, don't force people to use an specific application for doing an job as write an FAQ, that can be made in siple flat-file and imported into what ever You want to use for make it XML, PDF, etc.


Best regards,

MicCo Cool
-------------------------------------------
Make It Easy, Keep It Simple.
-------------------------------------------
Okay, there is one thing Linux is wayback on MS, Linux dont have the amount of securety updates.

This post was last modified: 12-01-2006 08:52 AM by MicCo.

12-01-2006 08:52 AM
Visit this user's website Find all posts by this user Quote this message in a reply
openstream
Newbie
*


Posts: 9
Group: Registered
Joined: Nov 2006
Status: Offline
Reputation: 0
Post: #13
RE: FAQ - Writers needed!

I agree. Let's see how it will all come out in the end. The main thing is that there is some documentation at all. If it's nicely structured and reusable - all the better Wink


Unfortunately, no one can be told what the Matrix is. You have to see it for yourself.
12-01-2006 09:18 AM
Visit this user's website Find all posts by this user Quote this message in a reply
MicCo
Junior Member
****
Dev Team

Posts: 213
Group: Dev Team
Joined: Oct 2006
Status: Offline
Reputation: 2
Post: #14
RE: FAQ - Writers needed!

openstream Wrote:
I agree. Let's see how it will all come out in the end. The main thing is that there is some documentation at all. If it's nicely structured and reusable - all the better Wink


That's what it's all about! Cool


Best regards,

MicCo Cool
-------------------------------------------
Make It Easy, Keep It Simple.
-------------------------------------------
Okay, there is one thing Linux is wayback on MS, Linux dont have the amount of securety updates.
12-01-2006 09:31 AM
Visit this user's website Find all posts by this user Quote this message in a reply
ephigenie
Administrator
*******
Administrators

Posts: 661
Group: Administrators
Joined: Oct 2006
Status: Offline
Reputation: 12
Post: #15
RE: FAQ - Writers needed!

i've got phpmyfaq installed ... this allows us to receive questions of users transparently.

export can be done via xml, flatfile or even pdf. Via XSLT it should be possible to transform the xml output to whatever we want as a publishing document.
So in my opinion this is a good way to let the faq grow and contain useful information. And it is administrateable...

The same appears for the manual - i like the idea of a "living" manual (as practiced by lighttpd i.e.) only a few pages are set "read-only" (which means can only be changed by wiki-admins) but most of them can be changed by normal users.

On this way we got a manual which is in a good usability and exportable via plugins in different ways (currently only plain-text enabled)
But this way we can hope we get more people to write into the manual so that it reaches a good grade of completeness and perhaps helpful user-experiences in addition written down there.

12-03-2006 01:32 AM
Visit this user's website Find all posts by this user Quote this message in a reply
porphyrous



Posts: 3
Group: Registered
Joined: Feb 2007
Status: Offline
Reputation: 0
Post: #16
RE: FAQ - Writers needed!

It appears you have the task well in hand. I am unsure of the nationalities of the people involved here and their languages, but I offer myself as a proofreader for standard American English if you like. E-mail me if you can use me.

David V

02-16-2007 12:55 AM
Find all posts by this user Quote this message in a reply
ephigenie
Administrator
*******
Administrators

Posts: 661
Group: Administrators
Joined: Oct 2006
Status: Offline
Reputation: 12
Post: #17
RE: FAQ - Writers needed!

hm we need actually people writing faq's - proofreading them is the second step....

02-16-2007 02:12 AM
Visit this user's website Find all posts by this user Quote this message in a reply
Kermit
Junior Member
*


Posts: 75
Group: Registered
Joined: Jan 2007
Status: Offline
Reputation: 0
Post: #18
RE: FAQ - Writers needed!

ephigenie Wrote:
hm we need actually people writing faq's - proofreading them is the second step....


I think the two could go in parallels... I write 5 FAQ, he correct 5 FAQ, where is the trouble?

Anycase, as mantions in the ML, I'm available to fill some faq, some at a time...


.oO Kermit Oo.
THE MAN, beta version
02-16-2007 07:19 PM
Visit this user's website Find all posts by this user Quote this message in a reply
ephigenie
Administrator
*******
Administrators

Posts: 661
Group: Administrators
Joined: Oct 2006
Status: Offline
Reputation: 12
Post: #19
RE: FAQ - Writers needed!

yeah ok - i don't see a problem here Wink
It's just that we primary need more Documentation Smile
that was all i was saying. And then : for sure I'm glad if someone wants to help - and we need people doing things like that.

Perhaps thats my bad english preventing me from hiding my question too good for him Smile
So i may ask directly if he'd like to write some faq also ? Wink

02-16-2007 08:15 PM
Visit this user's website Find all posts by this user Quote this message in a reply
Kermit
Junior Member
*


Posts: 75
Group: Registered
Joined: Jan 2007
Status: Offline
Reputation: 0
Post: #20
RE: FAQ - Writers needed!

Don't warry ephi! ^_^
Mine also was just a tought... my english is surely worse than your! Wink

I'll take a trip into the faw system asap! And of course, if Porphyrous wants to do the same, he will be welcomed!!!


.oO Kermit Oo.
THE MAN, beta version
02-16-2007 08:50 PM
Visit this user's website Find all posts by this user Quote this message in a reply
Post Reply  Post Thread 

View a Printable Version
Send this Thread to a Friend
Subscribe to this Thread | Add Thread to Favorites

Forum Jump:

| All rights reserved : isp-control.net |