SMF Documentation Help Squad

SMF Team Blog

Navigation

SMF Documentation Help Squad

Posted by Jade Elizabeth on November 19, 2008, 12:01:42 AM

Hello Simple Machines community!!

My name is Jade, and I work on the SMF Online Manual as a Documentation Writer. I wanted to tell everyone about a very special group which I lead, called the Documentation Help Squad.

The Documentation Help Squad

The Documentation Help Squad is a group of people who volunteer their time to work on the Online Manual. They correct, re-write, update and write documentation. They have the ability to choose what they do, and there are no deadlines, so they are free to work at their own pace

.

Ultimately, the Help Squad is for helping the current Documentation Writers keep the manual up to date and error free.

What the Help Squad Does

The help squad does many things to help us, so here is an extended explanation of each thing they can do. Of course they are not limited to these things, but these are the main things.

Correct a Document
Most Documentation Help Squad members start by correcting documents. This is a simple process, where documents are scanned for:

Dead images or links
Missing links
Grammatical errors
Contextual errors
Wording errors
Missing information
Coding errors (missing/visible BBC tags, etc)
Anything else that could be wrong

The corrections need to be submitted in a certain way, so we made our very own form for it! The Easy Correction Submission Form was made to make it easier for corrections to be submitted, and is very simple to use. More about that later!

Upgrade a Document
Upgrading a document is usually something simple that Documentation Help Squad members can choose to do. Upgrading a document is basically adding information for new versions, like SMF 2.0 for example. It is usually quick and easy, though sometimes you notice other errors and end up doing a re-write

.

Re-write a Document
Re-writing a document involves rewording, correcting, and (sometimes) upgrading an existing document. Re-writes are different to corrections and upgrades because the finished product is nothing like the original. The new document should be error free, professional, and easy for readers to understand.

Write a Document
Writing a document from scratch, especially for a new 2.0 section, can be one of the hardest jobs the Online Manual has to offer. Writing a new document can be a little frustrating at first, but in the end it is worth it! Knowing your document is out there helping others is a great feeling

.

The Help Squad Tools

The Documentation Help Squad has numerous tools available to help them with any of the above jobs they may choose. I ensure the Help Squad has all the help I can give them.

The Easy Correction Submission Form
As we mentioned before, this form makes submitting corrections easy! You input your corrections and press a button. It gives you code for posting, and then you post it! Want to see it? Click me!

The Online Manual Master List
The Master List is a list of every document on the Online Manual. Currently there are 315 public documents. The list also includes documents to be written, corrected or edited. The Master List is maintained and updated regularly.

The Toolbox
The Toolbox is a GREAT resource for EVERYONE! Inside are extensive guides on writing for the Online Manual, all hand written and customised for the Online Manuals needs. The guides include information on lists, links, headings, and general wording. Reading these is a MUST before beginning work!

Join The Help Squad Today!

Want to join? Need more convincing?

Reasons to Join:

A GREAT way to help SMF, and its community
It's fun and rewarding
- Help others
- Learn better writing skills
- Your documents could go public!
You work WITH real people, possibly including SMF team members, SMF friends, and other Help Squad members
You could become an OFFICIAL SMF Documentation Writer!! I started in the Help Squad

How to Join the Help Squad:
If you want to join, please sign up for an account on the Online Manual and send me or akabugeyes a PM with your Online Manual username (let us know you want to join the Help Squad too). One of us will give you access ASAP.

Digg It!

Comments

Joomlamz on November 19, 2008, 01:55:57 AM said:

it has to be English or another would like to help more in Portuguese

Jade Elizabeth on November 19, 2008, 11:00:17 AM said:

Unfortunately at this time it needs to be English. At a later date when the Online Manual is error free and at a higher standard we will most likely welcome translations

.

Thanks for your interest though

Jade Elizabeth on November 20, 2008, 08:50:36 AM said:

Just because I like to brag, recently a Documentation Help Squad member had one of their re-writes go public!
See the finished product here: http://docs.simplemachines.org/index.php?topic=184.0

The original was messy, short, and unorganised, but Project Evolution did a great job getting it up to the Online Manual standard! Congratulations to him!

Soon I will be announcing these sort of things publicly, so you will see lots of monthly blogs from me in the future

Project Evolution on November 20, 2008, 06:52:37 PM said:

Hehehe thanks!

Remember, that no matter what knowledge you have with SMF you can always be a big help to the Documentation Help Squad. I learned this from Jade.

Jade Elizabeth on November 20, 2008, 06:54:32 PM said:

That's right!!
And you're doing great, just like the rest of the squad, so don't give up!

migueldefender on November 21, 2008, 01:48:45 PM said:

Everything that came from Jade, it only can have a great quality.

Jade this "SMF Wikipedia" it will be great for guys like me who don't know anything about SMF.

Best regards from Portugal,
Miguel

Jade Elizabeth on November 21, 2008, 06:32:13 PM said:

Thank you

I'm working hard currently to re-write the entire thing. It's an offline WIP but you will see it some day

Robinh on November 30, 2008, 01:04:55 AM said:

I'm diggin it! Thanks for the link to this post. I used to write technical documentation for the Air Farce back in the good ole days, and still do some with my current company. Looking forward to helping out!!!

Jade Elizabeth on November 30, 2008, 02:44:50 AM said:

Awesome

Glad to have you helping out

Dazed on December 08, 2008, 04:44:47 PM said:

Jade I sent you a pm with my details.

Jade Elizabeth on December 08, 2008, 04:50:22 PM said:

I've set you up

Thanks for the interest!!

Project Evolution on December 08, 2008, 10:21:13 PM said:

Thanks to everyone whos taking a shot at this, trust me, its easier to learn SMF if you get to know the documentations and such.

Jade Elizabeth on December 09, 2008, 08:26:32 AM said:

With the amount of times I read all of my own docs I think I've learnt about it almost inside out

Well, from the admin perspective

Minare on January 20, 2009, 12:12:59 AM said:

I could make a good documentation writer & translator, actually I want to or else " I am going hoome ( Southpark - Cartman ) "

Jade Elizabeth on January 20, 2009, 08:21:33 AM said:

We're currently not ready to offer translations to the Online Manual. When the English version is up to standard, we will ask for translations

α¢αηѕ on January 21, 2009, 08:38:17 AM said:

Quote from: Jade on January 20, 2009, 08:21:33 AM

We're currently not ready to offer translations to the Online Manual. When the English version is up to standard, we will ask for translations

]

When we do i can translate to Australian English. I've or ready seen that SMF offers US English and British English. Aussie's need to read as well to.

Jade Elizabeth on January 21, 2009, 10:12:28 AM said:

Australian and British are the same thing. There arent many differences in American => Australian that we would come accross. Just spelling, but it's unimportant imo.

Save the translations for "real" languages

α¢αηѕ on January 21, 2009, 10:14:33 AM said:

This is coming from an Australian

also are you using the school computers

Antechinus on January 21, 2009, 10:17:18 AM said:

Where's your manic patriotism? Australian is a real language. Stone the crows, cobber, do you have any idea what you're implying?

α¢αηѕ on January 21, 2009, 10:18:54 AM said:

Bloke, Shelia, Shout, Ute, Stubby's

All invented by great Australians

Jade Elizabeth on January 21, 2009, 10:53:00 AM said:

Quote from: antechinus on January 21, 2009, 10:17:18 AM

Where's your manic patriotism? Australian is a real language. Stone the crows, cobber, do you have any idea what you're implying?

Lol okay Ant, if you can make me laugh like an idiot by translating this install document to Aussie, I'll consider letting someone do it:

Quote from: Jade on September 06, 2005, 04:33:22 PM

Installing an SMF forum has never been easier! Installing SMF can be done in five fast and simple steps:

1. Download the Install Archive
2. Extract and Upload the Install Archive
3. Set File Permissions
4. Create a Database and a Database User
5. Run the Installer

1. Download the Install Archive
The latest SMF release can be found on the downloads page of the official Simple Machines website.

Download the latest version of SMF from the official Simple Machines website. Commonly, .zip files are the preferred download type. Most operating systems have the tools available to extract .zip archives already installed. See Download File Types for more information.

2. Extract and Upload the Install Archive
Once the install archive has been downloaded it will need to be uploaded and extracted before the installer can be run. There are two possible methods for this step. The method used will depend on the tools available with the control panel supplied by the hosting service provided.

SMF can be uploaded to the site root, or to a directory on the site, such as www.yourdomain.com/forum.

Uploading Before Extracting
Some control panels have the ability to extract an archive, such as cPanel. This allows for hassle free uploading and extraction of the archive. Once the archive is uploaded, select the extract option to extract the archive to the desired location.

Extracting Before Uploading
If extracting abilities are not available inside the control panel, the archive can be extracted before uploading. Generally right clicking the archive and selecting the extract all option will work. The directory structure should be retained when the install archived is extracted, so all files and directories are in the correct places.

3. Set File Permissions
After the install archive has been uploaded and extracted, the files need to have their permissions set. This is commonly called CHMOD. The correct CHMOD for SMF files is either 777, 775 or 755, depending on the hosting service provided. There are two methods for this step, the method used depends on the hosting service provided. For more information on CHMOD, see how do I use CHMOD? / what is CHMOD?.

Setting File Permissions With the Installer
The SMF installer can set file permissions simply and easily. Navigating to the directory where SMF resides, should redirect to the install.php file and prompt the installer. For eg: www.yourdomain.com/forum/install.php. If the installer detects files that need their permissions adjusted it will prompt for FTP details so it can CHMOD the files it requires for the install. This may not work on some servers.

Setting File Permissions With FTP
Using a control panel or FTP client, file permissions can be changed quickly and easily. Usually, FTP programs will allow permissions to be changed by right clicking files/directories and selecting properties, attributes or permissions. The desired numerical value can be entered, or if provided, check boxes can be changed. For more information on FTP, see how do I use FTP? / what is FTP?

The Following files and directories should have CHMOD values of 777, 775 or 755:
/attachments
/avatars
/Packages
/Packages/installed.list
/Smileys
/Themes
/Themes/default/languages/Install.english.php
agreement.txt
Settings.php
Settings_bak.php
install.php

4. Create a Database and a Database User
Before running the installer, a database and a database user will need to be created. A database will store all of the information a forum requires, such as members, posts, and topics. A database user will allow the forum to access the stored information. The information for the database and the database user should be remembered for use with the installer.

Creating a Database Using phpMyAdmin
Most shared hosting services disable this option. If the option to create databases through phpMyAdmin is available through the hosting service provided, the database can be created from the phpMyAdmin home page.

Creating a Database Using a Control Panel
Shared hosting services usually disable the ability to create a database through phpMyAdmin. If the hosting service provides a control panel interface, this can be used to create a database. Selecting the MySQL Databases or Database Wizard option should take you to prompts for creating a MySQL database. With different hosts these options may have different names.

SMF 2.0 has the ability to support other database schemas, including PostgreSQL and SQLite. SMF 1.1 supports only MySQL database schemas.

Creating a Database User
database user can be created through the control panel provided by the hosting service. Selecting the MySQL Databases or database Wizard option should take you to prompts for creating a MySQL database user. With different hosts these options may have different names. These options may change if a different database schema is used for SMF.

The database user requires the following permissions, however, more can be granted: SELECT, INSERT, UPDATE, DELETE, ALTER, and INDEX.

5. Run the Installer
<img src="images/install11.gif" align="right" title="SMF 1.1 Install Screen" alt="SMF 1.1 Install Screen" border="0" style="margin: 10px;" />
The final step in installing SMF is running the installer. The information from the previous steps will be used in the installation process.

The SMF install screen looks different for SMF 2.0 and SMF 1.1, however, both still require the same information. Navigating to the directory where SMF resides, should redirect to the install.php file and prompt the installer to run. For eg: www.yourdomain.com/forum/install.php.

Basic Forum Settings
Forum Name – The name for the forum being installed should go here. By default this is set to “My Community”. This can be changed later via the server settings section of the administration center if needed.
Forum URL – The URL the forum can be found at, without the trailing slash. The SMF installer will most likely have this correct, so it is safe to leave this field alone.
Gzip Output – If Gzip output tests pass, this can be used to save bandwidth and make pages load faster.
Database Sessions – Sessions can be stored in the database, or in files. Database sessions are more reliable, secure, and may work better on sites with multiple servers.
UTF-8 Character Set – UTF-8 character sets are useful for international forums, or forums that use languages other than English.
Allow Stat Collection – This option allows Simple Machines to collect statistics from your forum, anonymously, so the software can grow to meet the needs of its user base. For more information on statistic collection, please see the statistics collection information page.

Database Server Settings
Database type – The database schema can be selected here from a list of database schemas supported by the server being used. Newer schemas (for SMF 2.0) such as PostgreSQL and SQLite may be listed here if available. MySQL and PostgreSQL are recommended.
Server name – The location of the database is specified here. 99% of the time this will be localhost.
Username – The username used for the database user should be placed here. If help is required for this, the hosting service provider should be contacted.
Password - The password for the database user is entered here.
Database name – The name used for the database should be placed here. If help is required for this, the hosting service provider should be contacted.
Database prefix – The prefix for all tables associated with this install is specified here. Prefixing tables with unique prefixes enables more than one application, or SMF install, to use the same database safely.

Creating an Administrator Account
The SMF installer will ask for information to create the forums administrator account. This information includes username, password, and email, just like a regular account. Once created, this account can be used to visit the administration center to manage and configure the forum.

Finishing the Installation Process
Once all parts of the install have completed, check the box to remove the install files from the server. If this does not work they will need to be deleted via FTP. All installer files should be removed from the server once the installation process is complete as they are a major security risk if left on a server unattended. Once SMF is installed they are no longer needed.

Congratulations on installing SMF successfully!! Simple Machines hopes you enjoy using SMF! If you require support, you may ask for it on the community or search the Online Manual for help.

Installation Errors
Sometimes the installer runs into an error when installing. Most errors are documented in the installation questions FAQ section.

If the error encountered is not documented, the install and upgrade help board on the community can assist in fixing the error.

It might have errors, there's a new linking system by "keyword" that we're testing, so I had to remove that code from it

Good luck

Quote from: α¢αηѕ on January 21, 2009, 10:14:33 AM

This is coming from an Australian

also are you using the school computers

We have phrases sure. I've been considering an SMF translation for a while to Aussie....but I havent gotten around to it.

Antechinus on January 21, 2009, 10:55:33 AM said:

Quote from: α¢αηѕ on January 21, 2009, 10:18:54 AM

Bloke, Shelia, Shout, Ute, Stubby's

All invented by great Australians

Bloody oath, digger. That sheila was trying to lump us in with the Pommies and Septics.

Quote from: The Traitorous Wench

Lol okay Ant, if you can make me laugh like an idiot by translating this install document to Aussie, I'll consider letting someone do it:

Be careful what you ask for.

α¢αηѕ on January 21, 2009, 10:57:30 AM said:

Do you wanna split the work ant, I'll take the first half.

Jade Elizabeth on January 21, 2009, 10:59:44 AM said:

Lord.

Do it

α¢αηѕ on January 21, 2009, 11:01:22 AM said:

Or ready started

Antechinus on January 21, 2009, 11:02:01 AM said:

Quote from: α¢αηѕ on January 21, 2009, 10:57:30 AM

Do you wanna split the work ant, I'll take the first half.

We should scull a dozen tinnies each and then do alternate sentences without cross checking.

α¢αηѕ on January 21, 2009, 11:04:21 AM said:

Quote from: antechinus on January 21, 2009, 11:02:01 AM

Quote from: α¢αηѕ on January 21, 2009, 10:57:30 AM
Do you wanna split the work ant, I'll take the first half.
We should scull a dozen tinnies each and then do alternate sentences without cross checking.

well i've or ready taken a ganda at that one above so i'll just finish it.

α¢αηѕ on January 21, 2009, 11:15:30 AM said:

Quote from: Acans Australian Translation

Installing an SMF forum is easier than throwing snages on the barby! You can do it in 5 easy steps mate.

1. flog the Install doobie
2. open and put the Install doobie
3. Set the File Permissions mate
4. Make on of those Database and a User
5. Start teh Installer

1. Download the Install doobie
The latest SMF release can be found by taking a ganda at the SMF website.

Flog the latest version of SMF from the official Simple Machines website. usually, .zip files are the preferred flogging type. Most porn boxes have the tools available to open the .zip archives already installed. Take a ganda at the Download File Types for more information.

2. Open and put the Install doobie
Once the install doobie has been you need to put and open so you can install it mate. There are two ways to lay these bricks.