Greetings to the Simple Machines Community. I would like to reach out to the community here to formally ask for the help of dedicated SMF users who are at all interested in helping to improve the documentation of SMF.
As it current stands the SMF Documentation Team consists of only a few members. As a consequence of limited outside assistance the Documentation Team bears the responsibility of documenting the SMF software by themselves. Occasionally the Documentation Team receives help from other Team Members of SMF, however usually they have their own duties that they need to fulfill so they cannot concentrate extensively on working on SMF documentation.
So what can you do to help?Well to put it simply...
anything!
But to elaborate on what we mean by anything, the following are examples of things you can do to help the Documentation Team:
- You can proofread documents for something as simple as typos.
- You can look through the documents for any content that is unclear or could use elaboration. Even if you do know what the document is conveying to the reader, you can try reading it as if you are a newcomer to SMF and then try to see if you still think you would understand everything you read. You can either tell us where the unclear fragments are, or if you think you are a decent writer, you can come up with a suggestion of what to change the unclear fragments to.
- You can look for out-of-date documents which need to be updated to help the reader understand the content better.
- You can look through the sections of the Online Manual (http://docs.simplemachines.org) and find topics of SMF that you think are missing. From there you can make a post on the Online Manual (http://docs.simplemachines.org) under the Document Requests (http://docs.simplemachines.org/index.php?board=15.0) board suggesting a certain document or documents to be written. You of course could offer a hand in writing an unofficial version of the document that the Documentation Team may be able to take and adapt into an official Online Manual (http://docs.simplemachines.org) document!
A great way to start helping is to join the
SMF Doc Helper Group on the Online Manual (http://docs.simplemachines.org). From there you will be able to help in a slightly more formal environment, and get to meet and work with other SMF enthusiasts who have pledged to help out with documentation. Resources will be made available to helpers as well as the assistance of members of the Simple Machines Team. Helping us with documentation also provides good experience in the field of writing allows you to expand your knowledge of SMF, as well as providing a good opportunity to get to meet and become friends with many of the members of the SMF Team.
To join the
Doc Helper Group you simply need to register for an account (http://docs.simplemachines.org/index.php?action=register) on the Online Manual (http://docs.simplemachines.org) and then send an email (
[email protected]) to us, and being sure to tell us what email address you used to sign up for an account with. You will then be given access to some special resources available to the
Doc Helper Group and will be contacted with details with more information about the program.
Please consider helping us with documentation in anyway that you can. Every small contribution in making the Online Manual (http://docs.simplemachines.org) a more useful place for SMF users is appreciated!
Thanks.
Jack Thorsen, SMF Document Coordinator on behalf of the Simple Machines Documentation Team and the Simple Machines Team.
Hey guys :D
I wanted to add a little more about the Doc Helper Group.
I run a training center for those who want to learn to write for the manual, where I interact with these users and help them understand the structure and formatting, wording, etc. that the manual currently uses. Users who enter this center have easy access to docs that need to be updated or rewritten and can be assigned to docs if they wish. They also get daily help and attention from me and other members (including SMF team members), so they can ask a million questions and get the help they need to complete what they're working on. I'm there every day, so you will always have someone around to look over your work and help you with it so you arent alone.
I started out in the Helper Group and I had a lot of fun...I still do now as an official Doc Writer. It's been a positive experience for me, and I've taken away some life lessons and skills to help me. I made a lot of new friends, including team members, and now I'm a part of something bigger. I was afraid to try at first, but now I'm glad I did :D.
Not to mention, this would look great on a resume. Employers always look for those who have good writing skills (and we can help you improve those) and like to see some volunteer work on resumes.
well sir,
i would like to join you as well.
I'm good with typing, I type pretty fast.
If you need helpers, i would like to help you.
Please reply me ASAP.
thanks,
RuneGold
Hey RuneGold :D
We would love for you to join us :D
First you need to sign up for an account on the Online Manual
http://docs.simplemachines.org/index.php <Register button is up top
When you have done that let me know your username so I can put you on the Help Squad team :D.
Thank you for your interest :D.
Would love to help with this as I know SMF 2.0 fairly well. However I just don't have the time :/ Once as I get a bunch of things done for a few websites and have time to work on some SMF mods then I will also look at helping with documentation as much as possible. I also want to make some tutorials on how to make your own mods for SMF, I think they would be good to encourage people who are just starting out in PHP to use SMF to get started.
Hope to help SMF soonish...
That would be great, we have a mod section on the Online Manual which needs some attention. Unfortunately I don't possess the knowledge to fix it.
I will probably get back in tune very soon. With helping with the docs and SMF support just been a bit busy the last few months.
Glad to hear Shadow :D.
Hiya. Hey I tried your tip about the SMF default theme but didn't see anything "interesting". However it did remind me what an outdated looking theme it is. :P I hope using it wont be obligatory.
What am I missing?
It's not obligatory, but it is easier for you.
Should you be missing something?
Well for a start it lacks the links to Docs and downloads, etc at the top of the page. :P
Hey I'll stick with the site default I think.
Okay. The Default (according to Jack) does not have the "new topic" button, so be aware of that.
No worries. Attach the template and I'll edit it for you. :D
Cannot do that, sorry. If Jack wants it there he will put it there :).
ROFL. Ok, if you have anything that needs proofreading how about you shoot that over to me. It's as good a starting point as any. Proofreading I can do.
Well, every doc in the OM need it. Pick any one of them and you're good :).
This look's pretty neat. :)
Dear sir,
I would like to join with you.
I also want to work on some language packs.
I really want to help you here.
Please reply me,
With thanks
jazzbrar
Hey Jazzbrar :D
Have you signed up to the Online Manual yet? When you have PM me your username and I will get you set up right away!
Thanks for the interest :D.
Hi Jade and akabugeyes,
I am interested in helping with the SMF Online Manual. I could write some docs for mods as well as cool things to do with SMF. :)
I have registered on the OM and my username is brianjw.
- Brian
I added you to the Documentation help squad and sent you a PM :D
Ok, I'll check it in a minute. :)
Awesome, thank you for your interest!
Just want to help with SMF some how. ;)
Anything a noob can do?
There is heaps a noob can do :)
Sign up and I will send you a PM which should explain it all :D.
I'd be interested in helping how I can. I'm learning SMF, so I'm sure I can offer a novice perspective and can easily kinda "document my learning experience" as I go along. So, I'll sign up and see what I can offer.
A few quick questions before I go off though, is there a wiki? And, in dealing with my perspective, when people's questions are answered in the help thread, is there opportunity to include it into the manual or make the answer more obvious? I feel that a good manual could be linked to answer most questions (a link to a specific section or such, not just a general link as no one likes to read an entire document to answer a simple question). And, this kind of interface between the manual and the forums ensures better documentation and more volunteers.
Well those questions can be answered by looking at the Online Manual ;)
FAQ's (http://docs.simplemachines.org/index.php)
There are many FAQ questions that are in demand, however, there is no wiki.
Let me know what your username is on the Online Manual and I will add you to the Help Squad group :D.
I just signed up and will be emailing you shortly. I do some web development as a hobby and have been using SMF for years. I'm willing to volunteer some time but travel for a living so my time might be limited to "whenever I can", but that's what volunteering is for.
I'm hoping that there's a way to check on progress so that I'm not going over ground that others have covered. I mean is there like a group leader who would assign specific review tasks and such who would tell me better where to go and what needs to be reviewed? Anyway, I'll also post this in my email, I think SMF is great!
Oh, also have a sandbox where I can test run SMF stuff if you also need someone to trial SMF goodies. Let me know!!!
There is.
I am the leader, and am more than happy to assist you :).
See this:
http://blogs.simplemachines.org/team/275357
Sent an email awhile back but have not received a response to it. Just wondering if it was received or not.
Would love to help out if needed.
:)
Probably not, I would appreciate it if you would read my blog here: http://blogs.simplemachines.org/team/275357
If you contact me you can get fast access as I am on every day :). So send me the username you chose and I'll set you up right away :D.
In regards to a thread I started HERE (http://www.simplemachines.org/community/index.php?topic=282466.0) it might be good to have instructions on how to start a forum from scratch. This could possibly make SMF extra $$ too. If you were to become affiliated with a host of some sort and include instructions through that host (similar to how I did with GD), then SMF could possibly make monthly affiliate $$ from this "From Scratch" instruction set by new members using the host suggested through your manual. I've just seen a lot of people in the forums asking about pre-install assistance and I think it would be very helpful for these members to have a place to reference.
Quote from: KahneFan on December 27, 2008, 01:06:08 AM
In regards to a thread I started HERE (http://www.simplemachines.org/community/index.php?topic=282466.0) it might be good to have instructions on how to start a forum from scratch. This could possibly make SMF extra $$ too. If you were to become affiliated with a host of some sort and include instructions through that host (similar to how I did with GD), then SMF could possibly make monthly affiliate $$ from this "From Scratch" instruction set by new members using the host suggested through your manual. I've just seen a lot of people in the forums asking about pre-install assistance and I think it would be very helpful for these members to have a place to reference.
preety shore THIS (http://docs.simplemachines.org/index.php) covers it all, most people just need to take a look. I dont think theirs a How to get a domain but your free to write one and show jade. She said she was going to be gone for a week from 25 of dec (tho she made a post in the online manual today{Yes jade i seen that ;D}).
I'm back now.
I was actually creating a site dedicated to that....but I had to push it to the back burner because the Online Manual needs attention for the moment :).
Quote from: Jade on January 06, 2009, 08:32:09 AM
I'm back now.
I was actually creating a site dedicated to that....but I had to push it to the back burner because the Online Manual needs attention for the moment :).
Cool, does that mean that you'll get to check out of the updates i made to my doc's, plus a new one i made.
I will get to that this weekend. I have to get all of my school stuff sorted out first :).
I'm ready to help with polish translation ;)
Are you still in need of help?
I am a total technomoron, so if you still need help and want someone to keep saying 'I don't understand that', then I am your woman...
Lol awesome, just PM me your Online Manual username (you have to sign up over there) and I'll set you up :D.
Well, that's all done (in between sorting out the evil broken legged daughter)...
PM on it's way...
I've set you up, thanks for the interest :D.
I will be glad to help anyway you need. Just let me know.
Regards.
German.
Thanks :D
If you want to join the help squad, follow the directions here: http://www.simplemachines.org/community/index.php?topic=275357.0
Hello,
I've read the document on this and I'm interested in helping the documentation team out and maybe long down the road become one myself, I'm sending an email to tell you what username and EMAIL I signed up with I hope to hear from you soon.
-[Hurricane]
Did you use the same one as here? I can set it up now :).
Hi Jade,
Yes it's the same Username & Email as I signed p with on here, I just sent you a PM though with both my Username & Email there, Going to go take a big long look over the Documents and see if I can find anything.
-[Hurricane]
Hey I would like to help, i'm not very good at editing but i still like to read over stuff etc my username is r3dh4wk1 (same as this account :P)
Quote from: r3dh4wk1 on September 28, 2009, 08:25:19 PM
Hey I would like to help, i'm not very good at editing but i still like to read over stuff etc my username is r3dh4wk1 (same as this account :P)
Sent you a PM, thanks for your offer to help. :)
I would LOVE to proofread! I am a A english student, that is why you'll see my posts with no mispellings (when I am using firefox-which is almost all the time, except for at the library, they use IE, which sucks)!
So, I could and would love to be a proofreader! AWESOME!
I will consider doing this if the workload is not overwhelming.
Quote from: Looking on October 29, 2009, 07:16:03 AM
I will consider doing this if the workload is not overwhelming.
That depends. When I ran it, it was work at your own pace step by step.....but it IS time consuming considering the progress. I won't lie to you.
I hope its not too late to sign up for this! I'm passionate about SMF and currently learning to create mods, proof-reading/writing documentation would help me tremendously!
I got a lot of free time anyway, so I can handle any workload :)
edit: I just registered and my username is legend
nope your not ill get a doc team member to message you :)
Thanks Runic. I'm impatiently waiting...:)
I'd love to join the Doc Helper group if I can. I used the same username (crazsyince95) and email on the docsite as I did on the forums. Thanks for considering! :)
Hello !
My knowledge of SMF are small, however, I converted my site with your help so as comfortable for me.
I am ready to write it in a manual (untill I have not forgotten how I did it), if you are interested in.
"Use <p></p> instead of <br /><br />" (http://www.simplemachines.org/community/index.php?topic=344103.msg2349684#msg2349684) - Full replace, full solution - nowhere <br /> in posts !
"How insert picture on left of topics names and subforums instead of icons ?" (http://www.simplemachines.org/community/index.php?topic=324472.msg2347603#msg2347603) - I have insert pictures in forum descriptrion and replace it left - instead of the icon, that show new topics, and icon replace to forun name line
: "Remove linktree from front page" (http://www.simplemachines.org/community/index.php?topic=249315.msg2355826#msg2355826), Word "Category" in LinkTree to be more popular
My e-mail is
zakaz (0) vveb.ws
Quote from: Vveb.ws on November 14, 2009, 01:38:38 AM
"Use <p></p> instead of <br /><br />" (http://www.simplemachines.org/community/index.php?topic=344103.msg2349684#msg2349684) - Full replace, full solution - nowhere <br /> in posts !
Does it deal with the other issues I raised in that thread, such as inside code tags? Or users wanting to put multiple blank lines in for visual effect?
Quote "How insert picture on left of topics names and subforums instead of icons ?" (http://www.simplemachines.org/community/index.php?topic=324472.msg2347603#msg2347603) - I have insert pictures in forum descriptrion and replace it left - instead of the icon, that show new topics, and icon replace to forun name line
Probably should be moved to Tips/Tricks.
Quote : "Remove linktree from front page" (http://www.simplemachines.org/community/index.php?topic=249315.msg2355826#msg2355826), Word "Category" in LinkTree to be more popular
That tip is not suitable to be put into the manual, it breaks one of the code rules for SMF, which I was fully aware of when I wrote it, but was suitable for your forum.
No offence intended, but I used to request that your English is very good if it's a second language :).
I don't run the Help Squad anymore since I quit SMF though :).
Quote from: Jade Elizabeth on November 14, 2009, 08:48:25 PM
No offence intended, but I used to request that your English is very good if it's a second language :).
I don't run the Help Squad anymore since I quit SMF though :).
Who runs it now, Trekkie or B?
I sent a message akaburgers but i havent gotten a message back yet.
I don't know if anyone is, sorry :(.
Quote from: Jade Elizabeth on November 15, 2009, 01:20:13 AM
I don't know if anyone is, sorry :(.
Dam, I want to start finishing and writing them again, just finished school for 11 weeks! :)
But their are no doc writers to check the squads documents.
I applied ages ago, still no response....:(
After a few months and a few PM's no replies here either... Oh well, I can volunteer my time elsewhere I suppose.
For those who still wish to help, please (re)send me a PM. I will eventually going through my inbox to see those I overlooked or neglected to contact, but it would be easier if I can get some of you who still are looking to get started to let me know via PM.
If you could in your message let me know a few things it may help me figure out how to make best use of these resources. Those things are:
Education (High School/College/Etc and/or proficiency with English language)
Availability (For instance, are you particularly more available for a certain number of weeks because you are on vacation?)
Location (or just your time zone)
Experience with SMF (do you know a lot or are you just getting started?)
All of this is optional, but it may be helpful for me to know.
Thank you. :)
me me me me me me me me me me me me me me me :D
Love to help if I can. Have done some manual writing in my time, mostly for PC software.
Have installed SMF from 1.1 upwards, installed Mods, dB's and some programming, though not much with PHP until I got into SMF.
Have registered at the doc forum.
Chas aka Hal9K
First, allow me to apologize for the confusion surrounding the Doc Helpers, lately. :) The group does still exist, and it's doing some great work on the documentation for SMF 2.0. If you (still) want to get involved, send me a private message. I'd be happy to get you setup and started.
B
Thanks for you
hi ive been using SMF for a number of years and would like to get involved please. ive helped the SMF community with mods last year under a different username. im a very fast typer and pretty savvy with php and html code.
If you'd like to get involved with this group, you need to contact groundup (http://www.simplemachines.org/community/index.php?action=profile;u=23). :) Sorry for any confusion our game of Doc Coordinator Musical Chairs may have caused. We expect that to settle down here now.
B
Quote from: alan1979 on May 24, 2010, 04:21:25 PM
hi ive been using SMF for a number of years and would like to get involved please. ive helped the SMF community with mods last year under a different username. im a very fast typer and pretty savvy with php and html code.
and why are you using two different usernames?
because i couldnt remember my log in details
is there any more spaces i would love to help i type quick please reply asap :)
Quote from: Tommy24 on September 05, 2010, 07:06:53 AMis there any more spaces i would love to help i type quick please reply asap :)
Read this: http://www.simplemachines.org/community/index.php?topic=398732.0
Would i be added into group?
You'll be automatically inside it...
I clicked it but why is my name not yellow?
Because you're not a team member... you're just helping the doc writers... if you're good, maybe you can get the badge :)
Quote from: DoctorMalboro on September 05, 2010, 12:28:53 PM
Because you're not a team member... you're just helping the doc writers... if you're good, maybe you can get the badge :)
Ok might be a nwb question Where do i start helping?
Read this: http://www.simplemachines.org/community/index.php?topic=360875.0
And this: http://www.simplemachines.org/community/index.php?topic=360931.0
And then start helping ;)
Mmhmm, I think people are still viewing this topic because of the link in the news...
Better PM Kindred about it.
Fixed.