We’re half way through the project! 6 weeks has absolutely flown by... 

This is what I ticked off the to-do list this week:

•  I re-arranged and tidied up the documentation. Each settings tab (or topic, in the case of audio) now has its own dedicated page. All the information you need to understand those settings are in one place; the first section on each page is an overview of the options, the second section goes into more detail, providing some background information and further explanation( or a how-to guide, in the case of the Cloud page). I hope that this way of presenting information is a little less confusing and easier to navigate - any feedback welcomed, as always! 

•  I added a section regarding games on the main page; where to get them, where to find which data files you need, and where to find whether they are supported/compatible.

After a discussion with @Mataniko this morning, my timeline for the next couple of weeks is as follows:

Week 7:

Help:

•  FAQ - pending feedback from the community, I will start working on a new FAQ which will hopefully be both relevant and useful. I anticipate that many questions will already have been answered in the documentation, and that I will be able to link back to this to supplement the answers. 

Ports (new section):

•  I will start using the information from the wiki to create port pages containing, at this stage, the following information:

•  Installation (not including how to homebrew)

•  Where to put the games

•  Control mapping

•  Port-specific settings

•  Known port issues - including unsupported games and unsupported features. 

I’ll start with the most active ports. According to traffic on the wiki, these are: Nintendo Switch, PS Vita and PSP. I’ll work on drafts based on the wiki information, but will reach out to porters to check that what I have is correct and up-to-date, and that nothing important is missing. 

Getting started:

•  iOS - I’m not happy with the GIFs currently on the iOS page. I will replace these with screenshots for clarity. 

Release notes (new section):

•  Add a release notes page for V2.2.0

Week 8:

•  Continue working on the FAQ and port pages, as I get more information from the community. This will probably be ongoing for the remainder of the project. 

•  I’d like to start thinking about how to set up a framework for documenting future features and releases, to ensure docs are always kept up to date! First draft. 

Docs-in-progress are available at scummvm-documentation.readthedocs.io

As always, I welcome feedback, criticism and suggestions! 

See you on Discord,

Cadi

 I’ve had a very productive week, now that my personal life has calmed down a bit. I added v2.2.0 information, and finished off the audio and graphics pages. I also created first drafts of the new “saving and loading games” page, as well as contacts, bug reporting, known problems, games notes and copy protection pages. 

A catch up with @Mataniko this morning has been very helpful to determine the path forward for the rest of the project, now that the bulk of the information is there. We spoke about what belongs in the documentation, and what doesn’t - and it was decided that things like “Games notes” from the readme, which I experimented with this week, will remain in the wiki, or will be added to the wiki if not there already. 

We also spoke about the user experience when navigating the documentation, so for the next week or two I will be tweaking the structure to make sure that the user gets the best possible outcome:

Week 6

Re-arranging the docs :

•  The settings pages as they are now have become much more involved than I realised they would be, and they are becoming challenging to navigate successfully on a single page. They will now have their own section in the docs - possibly even split into a section for global settings and a section for game-specific settings. Each settings tab will have its own page, containing full explanations of the relevant settings, instead of linking to explanatory pages (such as the audio/graphics pages currently).

•  The Using ScummVM section will be all about the user experience - how do I use the software to play the games.  Any information that doesn’t fit with this goal will be moved into other sections or pages. 

•  I’ll be adding a page (or pages) to point users to the appropriate places to find information about:

•  Where to get the games

•  Game compatibility/supported games

•  Data files

These subjects are not, by themselves, within the scope of this documentation project.

Week 7

•  The FAQ - I want to focus on the troubleshooting section of the FAQ, and I will probably name it as such in the Help section of the docs. Here I will need some help! 

Can I please get feedback on 1. What ARE the most common issues that people have? and 2. How a user would go about solving these problems? I haven’t had the opportunity to spend much time on the forums, but I suspect these most common questions probably come up a lot on the forums. Please tell me what they are! 

My hope is that the documentation will answer a lot of these questions, and I will just be able to link to the appropriate docs for the most part (and add information to the docs to cover the issue). 

Docs-in-progress are available at scummvm-documentation.readthedocs.io, merged docs at docs.scummvm.org.

As always, I welcome feedback, criticism and suggestions! 

See you on Discord,

Cadi

It’s been a crazy week; sold the boat, moved in with my in-laws, found a rental, moved out of my in-laws’, and moved into the rental.  All in the space of about 4 days! I think it’s time for a nap!

Nevertheless, I made a little progress this week, albeit not as much as I’d hoped:

•  I combined the install pages for Windows, Linux and Mac into one, at the suggestion of @Mataniko. I agree that this is a better way to do it.

•  First, second and third drafts of the Audio page. By far this is the most confusing subject for me, and I am forever indebted to @NMIError (and everyone who contributed this week) for all the information and corrections! I spent a fair bit of time on this one, as predicted, and there is still some information missing. I will continue with this next week. 

•  First draft of the Cloud and LAN page.

•  I took screenshots of the new v2.2 Launcher, although these are yet to be uploaded and changed on the Launcher/adding and playing games pages. I will most likely get this done tonight.

My timeline for the next couple of weeks, which unfortunately has some carryover items:

Week 5

_Advanced Options:

•  Audio - add sections about output sample rate and using compressed audio files.

•  Graphics - add information about OpenGL  

•  Configuration file - I think there are some audio options missing here, add these and split into [scummvm] and [game] categories. 

Using ScummVM:

•  Global/game settings - add v2.2 keymaps information.

•  Saving and loading games - new page, first draft.

Week 6

Help:

•  FAQ - first draft.

•  Known problems - first draft.

•  Reporting a bug - first draft.

•  Contacts

Docs-in-progress are available at scummvm-documentation.readthedocs.io, merged docs at docs.scummvm.org.

Thanks for all your support and as always, see you on Discord.

Cadi