Season of Docs: Week 2

 Week 2



Hi everyone,


I must say this has been a busy week for me, due to a variety of issues that don’t have all that much to do with this project; my computer died, and we (pretty much) sold our boat - so I’ve been working on a borrowed laptop while packing to move! Nevertheless, I managed to stay mostly on track for this week:


•  I updated the Launcher page with fresh screenshots and some other minor edits.

•  I spent a bit of time making the global and general settings pages more correct, and more understandable. Thanks to @criezy and @NMIError for your help with the graphics and audio settings.

•  I added all the configuration file keywords to the global/game settings pages.

•  I redesigned the Configuration file page, with every keyword linked to the appropriate section and description in the global/game settings pages. I’m not 100% sure yet how I feel about this way of presenting this information (nor is the page 100% done). If anyone has any feedback, ideas or objections, please let me know!


My plan for the next couple of weeks:


Week 3:

Using ScummVM:

•   Keyboard shortcuts  - Figure out the best way to present this information

•   Controls - Probably not much to go into this page right now, but once other port information is added this page will expand.

Advanced Options:

•  Configuration file - Fine tune how this information is presented, add some information about where to find the file etc.

•  Graphics - First draft.

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


Week 4:

Using ScummVM:

•  Cloud and LAN - First draft. 

Advanced Options:

•  Audio - A deeper dive into how this all works; first draft. I feel like this one might take a bit of time. 

If time permits:

Help

•  FAQ - First draft


As always, work-in-progess documentation is available to view at https://scummvm-documentation.readthedocs.io/en/latest/


See you on Discord, 


Cadi






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