76
edits
Difference between revisions of "Season of Docs/GSoD Ideas"
Jump to navigation
Jump to search
Add additional information on the task, qualifications and timelines
(→Tasks: Adding myself to the list of contact) |
(Add additional information on the task, qualifications and timelines) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 29: | Line 29: | ||
Difficulty level: Medium-hard. Might require some basic development skills if we opt in for something like Docusaurus | Difficulty level: Medium-hard. Might require some basic development skills if we opt in for something like Docusaurus | ||
This task would collect the various pieces of information from the README, Wiki, and ports and help organize them in a new portal. The new portal can be based on either Markdown or ReStructuredText and will allow us having versioned manuals for ScummVM in a format that's easy to edit and distribute | This task would collect the various pieces of information from the [https://github.com/scummvm/scummvm/blob/master/README.md README], [[Main Page|Wiki]], and ports and help organize them in a new portal. The new portal can be based on either Markdown or ReStructuredText and will allow us having versioned manuals for ScummVM in a format that's easy to edit and distribute | ||
As part of of this task, you and your mentors will work on: | As part of of this task, you and your mentors will work on: | ||
| Line 35: | Line 35: | ||
* Consolidate existing documentation efforts | * Consolidate existing documentation efforts | ||
* Define user journeys, document ScummVM's features, and create relevant manuals and guides. | * Define user journeys, document ScummVM's features, and create relevant manuals and guides. | ||
* Refresh the outdated User Manual | * Refresh the outdated [[User Manual]] | ||
A successful applicant will be able to demonstrate the following: | |||
* A good understanding of the ScummVM project - come around and ask us anything! | |||
* Writing ability and past writing examples - this task is focused on writing new content and rewriting existing content. | |||
* Knowledge of Markdown and/or RestructuredText | |||
The project timeline will roughly cover the following tasks: | |||
{| class="wikitable" | |||
! Week | |||
! Main task | |||
|- | |||
| Week 0 (Before 9/14) | |||
| Proposal discussion & reviews | |||
|- | |||
| Week 1 (9/14) | |||
| Doc portal set up | |||
|- | |||
| Week 2 (9/21) | |||
| Restructuring of the README into the portal | |||
|- | |||
| Week 3 (9/28) | |||
| Consolidation of port specific documentation | |||
|- | |||
| Week 4 (10/05) | |||
| Quickstart guide | |||
|- | |||
| Week 5 (10/12) | |||
| User Manual - Settings | |||
|- | |||
| Week 6 (10/19) | |||
| User Manual - Installation | |||
|- | |||
| Week 7 (10/26) | |||
| User Manual - Adding & Editing Games | |||
|- | |||
| Week 8 (11/02) | |||
| User Manual - Reporting issues | |||
|- | |||
| Week 9 (11/09) | |||
| User Manual - Advanced functionality | |||
|- | |||
| Week 10 (11/23) | |||
| Outstanding work | |||
|- | |||
| Week 11 (9/30) | |||
| Project summary and submission | |||
|} | |||
=== Improve source code documentation via Doxygen === | === Improve source code documentation via Doxygen === | ||
| Line 49: | Line 97: | ||
* Increase the consistency of coverage of our common, audio, backends, graphics, gui, images, video and engine code docs. | * Increase the consistency of coverage of our common, audio, backends, graphics, gui, images, video and engine code docs. | ||
* Clean up old, irrelevant documentation | * Clean up old, irrelevant documentation | ||
A successful applicant will be able to demonstrate the following: | |||
* Able to read code, C++ a plus. | |||
* Experience with code doc blocks, doxygen a plus | |||
* API documentation experience | |||
* CSS and HTML knowledge a plus | |||
The project timeline will roughly cover the following tasks: | |||
{| class="wikitable" | |||
! Week | |||
! Main task | |||
|- | |||
| Week 0 (Before 9/14) | |||
| Proposal discussion & reviews | |||
|- | |||
| Week 1 (9/14) | |||
| Doxygen build set up | |||
|- | |||
| Week 2 (9/21) | |||
| Refresh of Doxygen skin (low priority) | |||
|- | |||
| Week 3 (9/28) | |||
| Common code - OSystem, FS, Data Structures, Strings, etc. | |||
|- | |||
| Week 4 (10/05) | |||
| Common code - Continued | |||
|- | |||
| Week 5 (10/12) | |||
| Engines - Common code & sample engine | |||
|- | |||
| Week 6 (10/19) | |||
| Graphics | |||
|- | |||
| Week 7 (10/26) | |||
| Audio | |||
|- | |||
| Week 8 (11/02) | |||
| Video, Images | |||
|- | |||
| Week 9 (11/09) | |||
| Backends - Platforms, Graphics, Events | |||
|- | |||
| Week 10 (11/23) | |||
| Backends - Continued | |||
|- | |||
| Week 11 (9/30) | |||
| Project summary and submission | |||
|} | |||