Loading...
 
Skip to main content

Documentation


Would my documentation be a useful contribution?

posts: 34 Canada

Hello,

I'm partway through an internship that involves setting up some Wikis that will be used for research projects. I chose Tiki. Part of the project is to write concise, very easy to understand instructions for what we believe will be the the most vital Tiki functions. Basically, the goal of this documentation is to get users using Tiki as quickly as possible and to make it as easy as possible for users to find information.

I have completed most of them and put them on one of our Tiki installations. I've organized them by tasks, but I am looking for feedback on how to structure it to make it as easy as possible for users to find what they are looking for. I will be refining them by adding links between pages and some screenshots, but I was wondering if this documentation would be of use to the Tiki documentation community?

posts: 1001 Canada

Hi,
It's hard to answer without the doc under the eyes, but it's pretty cheap to make them public. The 1.8 doc "will" obviously be pretty different from the previous docs, check it if you want to know if it's different enough from your stuff.
If you have something consistent we could create an "Alternate documentation" category on tw.o and let you show the community your work there. We may then send you some reward coffee to write more 😉

posts: 34 Canada

> Chealer9:
> Hi,
> It's hard to answer without the doc under the eyes, but it's pretty cheap to make them public. The 1.8 doc "will" obviously be pretty different from the previous docs, check it if you want to know if it's different enough from your stuff.
> If you have something consistent we could create an "Alternate documentation" category on tw.o and let you show the community your work there. We may then send you some reward coffee to write more 😉

hiya,

Oh yup, i can link them hereQuestion. From what I understood from the 1.8 documentation, I think my documentation is a little bit different, sort of a quick reference. Or is there a better place for people to look at them and see if they're worthwhile?


posts: 34 Canada

> Chealer9:
> Hi,
> It's hard to answer without the doc under the eyes, but it's pretty cheap to make them public. The 1.8 doc "will" obviously be pretty different from the previous docs, check it if you want to know if it's different enough from your stuff.
> If you have something consistent we could create an "Alternate documentation" category on tw.o and let you show the community your work there. We may then send you some reward coffee to write more 😉

hiya,

Oh yup, i can link them hereQuestion. From what I understood from the 1.8 documentation, I think my documentation is a little bit different, sort of a quick reference. Or is there a better place for people to look at them and see if they're worthwhile?


posts: 1001 Canada

Hi superdude,
I looked at it, and it seems like more appropriated for a FAQ for most tasks, although Tiki FAQ sucks.
Maybe you could ask admins to provide you a "simple" doc subcategory, maybe.

posts: 34 Canada

> Chealer9:
> Hi superdude,
> I looked at it, and it seems like more appropriated for a FAQ for most tasks, although Tiki FAQ sucks.
> Maybe you could ask admins to provide you a "simple" doc subcategory, maybe.

hi Chealer,

Thank you for looking at my documentation. I will try contacting an admin about them.


posts: 34 Canada

> Chealer9:
> Hi superdude,
> I looked at it, and it seems like more appropriated for a FAQ for most tasks, although Tiki FAQ sucks.
> Maybe you could ask admins to provide you a "simple" doc subcategory, maybe.

hi Chealer,

Thank you for looking at my documentation. I will try contacting an admin about them.