The GNOME Foundation project
Stay organized with collections
Save and categorize content based on your preferences.
This page contains the details of a technical writing project accepted for
Google Season of Docs.
Project summary
- Open source organization:
- The GNOME Foundation
- Technical writer:
- Wise4rmGod
- Project name:
- GObject tutorial consolidation
- Project length:
- Long running (5 months)
Project description
The GLib object type system documentation contains an overview of the type system and of the base object class, with topics ranging from the lifetime of an object instance, to how to install properties; from interfaces to best practices on how to write object types; and a tutorial, which covers similar topics in a more narrative way. Ideally, we should only have a tutorial covering all topics, and have specialised, in-depth documentation for the more complex aspects of the API. The base concepts section should be merged with the tutorial section by having the former section use examples and a more narrative voice from the latter.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-08 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-08 UTC."],[[["\u003cp\u003eThe GNOME Foundation's GObject tutorial is being consolidated to improve clarity and accessibility for developers.\u003c/p\u003e\n"],["\u003cp\u003eThe project aims to merge the existing tutorial and base concepts documentation into a single, comprehensive guide with practical examples.\u003c/p\u003e\n"],["\u003cp\u003eThis long-running project, led by technical writer Wise4rmGod, will span five months as part of Google Season of Docs.\u003c/p\u003e\n"]]],["The core of this project is to consolidate GLib object type system documentation for the GNOME Foundation. The project, undertaken by technical writer Wise4rmGod over five months, aims to merge the current base concepts section with the tutorial section. This will involve rewriting the base concepts to use examples and a narrative voice, similar to the existing tutorial, creating a single, comprehensive tutorial that covers all aspects of the API, and moving more complex concepts to specialized documentation.\n"],null,["# The GNOME Foundation project\n\nThis page contains the details of a technical writing project accepted for\nGoogle Season of Docs.\n\n### Project summary\n\nOpen source organization:\n: The GNOME Foundation\n\nTechnical writer:\n: Wise4rmGod\n\nProject name:\n: GObject tutorial consolidation\n\nProject length:\n: Long running (5 months)\n\n### Project description\n\nThe GLib object type system documentation contains an overview of the type system and of the base object class, with topics ranging from the lifetime of an object instance, to how to install properties; from interfaces to best practices on how to write object types; and a tutorial, which covers similar topics in a more narrative way. Ideally, we should only have a tutorial covering all topics, and have specialised, in-depth documentation for the more complex aspects of the API. The base concepts section should be merged with the tutorial section by having the former section use examples and a more narrative voice from the latter."]]
