
The Launcher interface what each window and tab looks like as well as how they function.The reference documents should cover the following:
#Scummvm hotkeys how to
Users need reference documents that explain how to use ScummVM. How to launch ScummVM, add a game, and launch a game.
How to load games onto the chose platform, especially where it is not the platform the game was designed for. How to download the appropriate version of ScummVM. In cases where the install is not intuitive, or where the user may not have a strong technical base, the user needs a comprehensive guide for installing ScummVM on any of the supported platforms.Įach comprehensive installation page should cover the following: How to install ScummVM onto Windows, Mac and Linux. The quickstart guide should cover the following: While the install of ScummVM can be complex on some platforms, installing it onto a computer is not. New users often look for a quick start guide to get going as quickly as possible. Some information is missing or incomplete. It’s hard to know what information is current, and what is out of date. Information is hard to find and often duplicated it’s easy to get lost in obscure pages. The available ScummVM documentation is spread across multiple sources. To future-proof end user documentation by creating templates and detailed how-to instructions for future open source contributors.
To create a documentation portal using a static-site generator.Documentation should be easy to understand for beginners, without being patronizing to tech-savvy users.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.Project summary Open source organization: ScummVM Technical writer: Cadi Project name: Launch a Documentation Portal Project length: Standard length (3 months) Project description This page contains the details of a technical writing project accepted for