Season of Docs: Week 1

Well it’s nice to officially be underway! I’m happy to report that I’m ahead of my proposed timeline at the moment; some things that I expected to be time consuming have turned out to be pretty straightforward, and my proposal ended up with a lot more content in the prototype portal than I initially intended. All of which is to say that I’m very hopeful that this portal will be even more comprehensive than initially envisaged!  

A decision was made to focus (for now) on documentation for the more common ports - Windows, Linux, Mac, iOS and Android - so that has been my focus this week. I have first drafts in place for  “Getting Started” documents for most of those ports, which cover how to install ScummVM as well as how to get the game files where they need to be. 


My somewhat revised timeline now looks like this for the next few weeks:


Week 1 (this week): 

Getting Started:

Write draft install/quick start docs for Mac, Windows, Linux, iOS and Android.


Week 2: 

Using ScummVM:

•  The launcher - New screenshots and general edits.

•  Game/global settings - Edit engine-specific settings for clarity, general edits.

Advanced Options:

•  Configuration file - Rewrite. Possibly include the config keywords in the game/global settings pages and keep the contents of this page limited to “how to find” and “how to use” the config file.   


Week 3: 

Using ScummVM:

•  Keyboard shortcuts - Figure out the best way to display these!

•  Controls - Draft for control mapping on iOS/Android.

Advanced Options:

•  Command line interface - Edit to improve readability/usability.

•  Graphic filters and render modes - First draft.


I’ll probably keep making minor adjustments to this timeline in my weekly blog updates. 


Documentation can be viewed at https://scummvm-documentation.readthedocs.io/en/latest/


Well, I better get back to it. As always, hit me up on Discord with any ideas, thoughts or suggestions!


  


Comments

Post a Comment

Popular posts from this blog

Season of Docs: Project Report - Launch a Documentation Portal

  Project report: Launch a documentation portal •    The original proposal is available  here . •    The finished project, which will remain unchanged, is available  here . •    The live documentation is available  here . •   P ull requests available here  . The objectives The objectives, as set out in the project proposal: 1.    To produce high-quality, versioned end user documentation by consolidating large amounts of information from disparate sources and re-writing information for clarity, consistency, and completeness. Documentation should be easy to understand for beginners, without being patronizing to tech-savvy users. 2.     To create a documentation portal using a static-site generator. 3.    To future-proof end user documentation by creating templates and detailed how-to instructions for future open source contributors. The outcomes The completed documentation portal comfortably meets all the objectives: •    It is easy to follow, easy to navigate and pulls a large amount of
Read more

Season of Docs: Week 7

  What I accomplished during week 7: •  Started an FAQ. It’s got the basics, but I need more! Please keep the questions coming, I’ve only had two responses.... Link to Google Form her e . The FAQ still has formatting issues and definitely some grammar/spelling issues, so don’t judge too harshly (yet).  •  Created an “Other platforms” section, containing port-specific guides according to the agreed structure. I think they work quite well. •  Replaced the GIFs on the iOS page. I’m much happier with how they are now. Feedback on the use of GIFs vs screenshots would be appreciated. •  Added a “Release notes” section.  •  Moved extra information out of the Settings pages and into a new “Guides” section.  •  Got very, very confused by Git. At least now I (kind of) understand how to rebase. I think. Maybe.  I had a meeting with @mataniko this morning, and we discussed how to go about setting minimum requirements for documentation moving forward. It’s been decided that a new “documenta
Read more

Season of Docs: Week 5

  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
Read more