Season of Docs: Week 8

 Hi everyone,


It was a nicely productive week - due to rostering changes at my day job, I got an extra day off to work on this project!

 

This past week:


•  Added port pages as I received information. Thank you to those developers who reached out and answered my questions, I really appreciate it! Also a shoutout to user @IlDucci  who was my guinea pig for the Vita, PSP and especially the Dreamcast. 

•  Tweaked the FAQ; added a table of contents, general edits. 

•  Proofread/edited most of the pages for consistency and compliance with the Google style guide.

•  Completed a draft of the contribution guide for technical writers. With a few minor changes to be made, this will find its way into the wiki in the coming days.

•  Redesigned the landing page with a handy Bootstrap plugin. I quite like the result but feedback welcome as always. 

•  Fixed and then broke and then fixed the tables (again). Sphinx builds on Read the Docs can be a bit finnicky to say the least.... 

•  Played around with navigation, moved some sections around... Not quite happy with the result so will keep working on this. 


Following a discussion with @Mataniko this morning, I will finish off the port pages as/when I receive the information from developers, but essentially the focus now shifts from creating new content, to ensuring that the content that’s there is in the right place and that the user can readily find what they’re looking for. I will be moving some sections around, and some content around, and really just honing in on optimising the user experience. As pages are finalised, @Mataniko and I will work together to formally review them, and make any last changes as required. We’re getting close to the end now!


So my time for the following weeks will look a bit like this:


•  Continue work on Port pages as I get information.

•  Work towards final drafts of all pages, ready for review.

•  Continue working on finalising layout and navigation for maximum user friendliness.  

•  Work on PDF output; LaTex customization. 

•  Customise the theme; icon, colors, fonts, how it looks, any required CSS overrides. 


As always, documentation available for review at scummvm-documentation.rtfd.io.


Feedback, comments and suggestions always welcome!


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

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