Tryton 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:
- Tryton
- Technical writer:
- dave
- Project name:
- Documentation for Basic Modules
- Project length:
- Standard length (3 months)
Project description
In this project I propose to review and update the documentation for the basic Tryton modules. These are the modules that people will most commonly need to activate when setting up a Tryton system.
Improvements to Tryton's module documentation will help users find the right modules for their needs, and then help them setup and use their system. Good module documentation will allow users to find the answers to some of their basic questions without needing to wait for answers on the discussion forum.
The basic modules include as a minimum the: account, account_invoice, account_invoice_stock, account_product, company, country, currency, party, product, purchase, sale and stock modules.
There are three main audiences for the Tryton documentation, users, system administrators, and developers. To help target the documentation to each of these, I suggest that each module's documentation is split up into separate files inside the doc directory. These can include files containing a table of contents and description of the module, instructions for setting up the module, information about how to use the module, and details about the design and structure of the module. Depending on the module's functionality some of these files may not be required, and extra files can be created as needed. The module improvements will be along the lines of those I have already proposed for the party module: https://codereview.tryton.org/297241003/#ps327231002
Structuring the documentation like this will work well because the documentation is currently generated by Sphinx using reStructuredText files. As I make changes to the documentation they will be uploaded to the Tryton code review site, so they can be reviewed, and I can updated them as required. Once everyone is happy with them they can then, hopefully, be approved for inclusion in Tryton.
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\u003eThis project aims to enhance the documentation of Tryton's basic modules, making it easier for users to understand and utilize them effectively.\u003c/p\u003e\n"],["\u003cp\u003eThe documentation will be restructured for better clarity and accessibility, targeting users, administrators, and developers with separate sections for setup, usage, and design.\u003c/p\u003e\n"],["\u003cp\u003eThe project focuses on essential modules such as account, product, purchase, sale, and stock, crucial for setting up a Tryton system.\u003c/p\u003e\n"],["\u003cp\u003eProposed improvements will follow a structured approach, similar to those suggested for the party module, and will undergo thorough review on Tryton's code review site.\u003c/p\u003e\n"],["\u003cp\u003eThese improvements will empower users with self-service resources, reducing reliance on external support and facilitating a smoother Tryton experience.\u003c/p\u003e\n"]]],["The project focuses on enhancing the documentation for Tryton's basic modules, including account, product, and stock. The technical writer will review and update these modules' documentation to assist users in setup and usage. Documentation will be segmented into files for module descriptions, setup, usage, and design. Changes will be submitted to the Tryton code review site for feedback and approval. The goal is to help users and administrators with their common questions and use of the software.\n"],null,["# Tryton 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: Tryton\n\nTechnical writer:\n: dave\n\nProject name:\n: Documentation for Basic Modules\n\nProject length:\n: Standard length (3 months)\n\n### Project description\n\nIn this project I propose to review and update the documentation for the basic Tryton modules. These are the modules that people will most commonly need to activate when setting up a Tryton system.\n\nImprovements to Tryton's module documentation will help users find the right modules for their needs, and then help them setup and use their system. Good module documentation will allow users to find the answers to some of their basic questions without needing to wait for answers on the discussion forum.\n\nThe basic modules include as a minimum the: account, account_invoice, account_invoice_stock, account_product, company, country, currency, party, product, purchase, sale and stock modules.\n\nThere are three main audiences for the Tryton documentation, users, system administrators, and developers. To help target the documentation to each of these, I suggest that each module's documentation is split up into separate files inside the doc directory. These can include files containing a table of contents and description of the module, instructions for setting up the module, information about how to use the module, and details about the design and structure of the module. Depending on the module's functionality some of these files may not be required, and extra files can be created as needed. The module improvements will be along the lines of those I have already proposed for the party module: https://codereview.tryton.org/297241003/#ps327231002\n\nStructuring the documentation like this will work well because the documentation is currently generated by Sphinx using reStructuredText files. As I make changes to the documentation they will be uploaded to the Tryton code review site, so they can be reviewed, and I can updated them as required. Once everyone is happy with them they can then, hopefully, be approved for inclusion in Tryton."]]
