Jump to content
Usgu

Moving the user manual to the wiki

Recommended Posts

Background
You've read the official news: the official Squad wiki has arrived and Squad's PDF-based user manual will retire and transfer its content to the wiki. Because of this, there will be no more updates coming out for the user manual and version 1.1 will remain the last and final version of the user manual. In the transitionary period between now and until the wiki is firmly established, the manual and its translations will continue to fulfill their purpose of guiding new players into the game.

 

The life of the manual has been eventful. Its creation started in July 2015 during the early days of the Closed Pre-Alpha. After first publication in September it has seen two updates for each following month. For the Steam Early Access the manual was completely reworked and re-published in December, followed by another update in February. The manual's forum thread has accummulated over 50,000 views and over 250 replies, the manual was translated into 7 languages and another 8 languages were being worked on. The translation team consisted of well over 30 people, both individuals and organized Squad communitites.

 

I want to express my sincere gratitude to my dedicated translators - you did an amazing job and made a huge contribution to the worldwide Squad community - thank you. I do hope this is not a final goodbye but your contributions continue on the wiki and in other Squad community activities. Anyone interested in working on translations can do so on the wiki now. The wiki fully supports multiple languages. If you are interested, head over to the Translation portal to find out more. Right now though the focus will be on initial content creation in English. But once solid content is available on the wiki, translations will become a huge focus again.

 

Now it's time to hand over the content of the user manual to the community. The outline and content of the manual will be a good starting point to populate the wiki. There is little point in having and maintaining both, a comprehensive wiki and an user manual. It would be hard to draw a dividing line between both and keeping them separate; overlap would invite contractions and create duplicated effort. Also it's too much trouble for the readers to go to two resources to find what they are looking for. Of course, an user manual has its advantages and we will have to see if we will overcome the challenges that a wiki and a community-driving editorial brings.

 

First, we have to transfer and recreate the base content in the wiki. A huge undertaking which no indiviual can do alone - I am certainly not up to it. The community has to accept responsibility of the content and take action to make it happen. Secondly, when future Squad builds are released, content needs to be updated consistently across the entire wiki - no small task either. Of course, the wiki is much more than just the description of the basic gameplay. I am looking forward to seeing what the community will bring to the wiki. A wiki has a lot of strength and potential. To utlize that, the community has drive the wiki and make it an integral part and daily tool of itself.

 

Task: Porting the manual to the wiki
Everyone interested in contributing to the wiki, especially with the porting of the user manual to the wiki, go to the Community portal, you main starting point and information hub for all wiki editors. If you are new to a wiki, check out the Wiki Help pages.

 

In order to collaborate on the porting of the manual, you will need the following data and information:

  • The English user manual version 1.1 (PDF or OpenOffice document)
  • All images used in the manual as JPEG files. Please rename the files appropriately before uploading them to the wiki. Also, feel free to create new images if you see it necessary, I just wanted to provide the entire content of the user manual that could be used as interim placeholders for the time being.
  • Wiki Style Guide - the style guide contains only a few rules at the moment and is far from completion. Nevertheless, have a look. Also, as we go along with the wiki, we should add to the style guide in order to ensure all editors produce consistent work and we reduce unnecessary rework.

 

And here are some of the steps and considerations relevant to the porting process:

  1. For almost all headlines and sections from the user manual, the corresponding wiki pages have already been created. The pages should have been marked as "Stubs". A page stays a "stub" until all work on it has been completely finished. If a page is missing, create it, but please make sure it does not already exist. When you create a new page, please check the Wiki Style Guide to make sure you comply to established conventions.
  2. Check for list of stubs or look at the complete list of all pages. Pick a page of your choice from that list and work on its completion. It doesn't matter with which page you start - start with those you fancy working on most.
  3. Focus on the manual's chapter 5 as this is the core part of the gameplay that really needs to move to the wiki. Some other bits and pieces of the manual can also be moved to the wiki but are less urgent, and some parts from the manual are not needed at all on the wiki. It's up for the community to decide what else is needed and what isn't.
  4. As a starting point you can first copy over the plain text from the manual to the corresponding wiki page (note: copy & paste from the OpenOffice document is easier than from the PDF). Don't take the content from the manual as set in stone. Feel free to improve it, split up content differently than in the manual, or completely rewrite it from scratch.
  5. Once the text is finalized, don't forget to add lots of cross-reference links to relevant wiki pages. Every time you mention an important gameplay term, you should link to its page on the wiki. Also add formatting, tables and images to finish off the page. At the end don't forget to proof read it for spelling, syntax, completeness and comprehensibility.
  6. Even if you feel you are not knowledgable enough about Squad to contribute to this process, you can still help. Just duplicate the manual to the wiki page is still better than having nothing on the wiki at all.
  7. On many of the pre-created pages you will find some hints given from me or other editors. These hints are called "WIKI_TASK" (you can also search the wiki for this keyword to find all wiki task descriptions). These descriptions are intended to make your life as editor easier. Please remove the WIKI_TASK from the page when the task is finished (but not beforehand!) or add more hints to the description for fellow editors. Also make use of the Discussion pages to coordinate and collaborate with other editors. The beauty of the wiki is its collaborative aspect - make use of it.
  8. Don't take anything on the wiki as set in stone. If you thing something is missing or off, click that "edit" button and change or create it. The wiki and its content is by you and for you. The wiki is completely new to your community. We have to learn how to use it and how to work together on it. Please help integrate the wiki to the community and make it work for all of us.
  9. Besides the porting of the manual to the wiki, there's plenty of other content that needs creating. Feel free to work on other pages than the manual port, too.
  10. If you are unsure or need help, check the communication tools for the wiki community and the Wiki Help for help.

 

Any questions, thoughts or suggestions about porting the manual to the wiki? Post them in this thread.

 

Lets get to it. See you on the wiki. Your daily edits will bring a smile to my face. Lets see who's able to beat me on WikiPoints first.

 

P.S.: Many thanks to all those early helpers that have already started on the wiki over the last few weeks. Most notably ZiGreen, DoctorSnailer, ComedyInK, Switcher05 and SpamazoR.

 

Tip: I strongly recommend the use of browser add-ons for advertisment blockers if you work on the wiki. Otherwise the ads will slow down your entire browser if you have multiple tabs open. For Firefox, I use Adblock Plus.

Share this post


Link to post
Share on other sites

Nice!  I think the Wiki style will work great for the needs of Squad. Question: What kind of integration will the Wiki have with ingame? Will there be a link from the game to the wiki, an in-game browser for the wiki, or no attachment at all from in-game?

Share this post


Link to post
Share on other sites
1 hour ago, Mumble said:

Nice!  I think the Wiki style will work great for the needs of Squad. Question: What kind of integration will the Wiki have with ingame? Will there be a link from the game to the wiki, an in-game browser for the wiki, or no attachment at all from in-game?

 

The devs are considering to add a link to the wiki from the main menu. Lets wait and see. Maybe they will do even more.

 

You can open the wiki in Steam's in-game browser.

Share this post


Link to post
Share on other sites
Just now, Usgu said:

 

The devs are considering to add a link to the wiki from the main menu. Lets wait and see. Maybe they will do even more.

 

You can open the wiki in Steam's in-game browser.

Right-o. That would be nice integration if the wiki opened up in the steam browser even. :) although I know some people don't use the steam overlay, or it breaks sometimes.

Share this post


Link to post
Share on other sites

Started to adding entries as well to the wiki. Glad I can contribute.

Share this post


Link to post
Share on other sites

Just wanted to congratulate you guys for what you've done. I know the massive amount of work you're putting into this. Keep it up!

 

I'm very sorry for not being able to help.

 

Gal.-

Share this post


Link to post
Share on other sites

Update:

Ladies and Gentlemen, it's 4 weeks since the announcement of the wiki. Lots of work has been carried out by a dedicated group of community members. Big shoutout to them for their effort.

 

Looking at the current WikiPoints we have a clear leader at the top of the pack. "Wiki Editor of the month June 2016" goes to TomNedry. He is closely followed by ZiGreen and ISAFMOBIUS04. Keep up the good work!

 

Tom did a fine job. Check out his contributions to the maps, for example here and with the map grid distances.

 

azd2J4H.jpg

 

BTW, Wagnike2 and myself don't count. Him being of the offical Curse Inc wiki staff and myself being Wiki Guardian/admin and more of a coordinator.

 

The work isn't over. Please join the wiki and give it all your love.

Share this post


Link to post
Share on other sites
28 minutes ago, Usgu said:

... for example here and
 

 

I have to point out that the map pages were done by others. I just enhanced the wiki template for the "map infobox" ;-)

Share this post


Link to post
Share on other sites

yeah stop taking credit for shit I do Tom ;) but jokes aside it has been a group effort so every one gets a pat on the back. even if it's a small input it still helps and greatly improves the wiki   

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

×