Season of Docs: Week 6

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



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