Monday, July 25, 2016
2 changes · master
Enhancements to existing features
This pull request rewrites parts of the installation guide to make it easier to read, more welcoming, and less reliant on technical jargon. The change aims to help business users and new developers understand setup options more confidently, while correcting spelling and improving document structure.
Original PR description
Description of the issue/feature this PR addresses: This pull request aims to improve upon the structure, readability*, and completeness of the installation guide. ``` - It is overly explicit and…
Description of the issue/feature this PR addresses:
This pull request aims to improve upon the structure, readability*, and completeness of the installation guide.
```
- It is overly explicit and assumes nothing about the users level of experience —or familiarity with tech, until after the Packaged Installer methods.
- The Demo and SaaS sections are more sales slanted, as there could be small business owners trying to make a go of Odoo on their own.
- Removes references to limitations, where they are unhelpful: "Odoo has no limitations" :: wink ::
- It's conversational and inviting, until after the Windows Packaged Installer methods, with the goal of signaling Small Business owners: "we're helpful and friendly.. Call us and we wont talk over your head.."
- Signals to Developers that Odoo might be an easier FOSS to work with: "it's obviously committed to documentation... And it's explicit?!?"
- It makes a point to avoid contractions and confusing idioms, where possible in order to aid translation/readability (i.e., you're to you are; je m'appelle to je me apelle)
- Strips some industry jargon/acronyms or approaches them more friendly ―potential customers, "I can do this"; developers, "I don't know x or y, but I could use this and contribute z..."
```
- See below...
Is Your Business Writing Too Smart for Its Own Good?
http://www.printwand.com/blog/is-your-business-writing-too-smart-for-its-own-good
How to Write for an Eighth-Grade Reading Level
http://www.proedit.com/how-to-write-for-an-eighth-grade-reading-level/
Current behavior before PR:
Flesch-Kincaid Grade Level, SMOG, Coleman Liau Avg: 12th Grade
Desired behavior after PR is merged:
It's not ready to be merged. Just looking for guidance:
Flesch Kincaid Grade Level: 9th Grade
Flesch Kincaid Reading Ease: +11 points
I confirm I have signed the CLA and read the PR guidelines at www.odoo.com/submit-pr
Cody KittermanThe Odoo command-line documentation has been reorganized and expanded to make setup and configuration guidance easier to find. This helps developers onboard faster and reduces time spent searching source code for available options.
Original PR description
Description of the issue/feature this PR addresses: This pull request aims to improve upon the structure, readability, and completeness of the "Command-line interface: odoo.py" documentation. Current behavior before PR: N/A Desired behavior after PR is merged: I hope to make it even easier for new Odoo developers to get started, or to save more seasoned developers the hassle of referring to command.py. ## I confirm I have signed the CLA and read the PR guidelines at www.odoo.com/submit-pr Cody Kitterman