Current time: 04-27-2024, 02:01 PM Hello There, Guest! (LoginRegister)


Thread Closed 
FAQ - Writers needed!
Author Message
openstream Offline
Newbie
*

Posts: 9
Joined: Nov 2006
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.
12-01-2006 08:31 AM
Visit this user's website Find all posts by this user
MicCo Offline
Moderator
*****
Moderators

Posts: 277
Joined: Oct 2006
Reputation: 1
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.
(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
openstream Offline
Newbie
*

Posts: 9
Joined: Nov 2006
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
12-01-2006 09:18 AM
Visit this user's website Find all posts by this user
MicCo Offline
Moderator
*****
Moderators

Posts: 277
Joined: Oct 2006
Reputation: 1
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
12-01-2006 09:31 AM
Visit this user's website Find all posts by this user
ephigenie Offline
Project Leader
*******
Administrators

Posts: 1,578
Joined: Oct 2006
Reputation: 15
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
porphyrous Offline


Posts: 3
Joined: Feb 2007
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
ephigenie Offline
Project Leader
*******
Administrators

Posts: 1,578
Joined: Oct 2006
Reputation: 15
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
Kermit Offline
Junior Member
*

Posts: 75
Joined: Jan 2007
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...
02-16-2007 07:19 PM
Visit this user's website Find all posts by this user
ephigenie Offline
Project Leader
*******
Administrators

Posts: 1,578
Joined: Oct 2006
Reputation: 15
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
Kermit Offline
Junior Member
*

Posts: 75
Joined: Jan 2007
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!!!
02-16-2007 08:50 PM
Visit this user's website Find all posts by this user
Thread Closed 


Forum Jump:


User(s) browsing this thread: 1 Guest(s)