Content writing guidelines and principles
The principles behind every Qodo article
A Qodo article is written to be the most useful answer you can find on its subject. Qodo builds tools that hold code to a high bar, and we hold our content to the same one: quality in the product means quality in the content. Here are the principles every piece follows, and how we put each into practice.
1. Our topics and ideas come from skilled and experienced team members and aim to solve real developer problems
We ideate our topics internally based on questions customers ask on calls, thought leadership and product vision as well as latest industry trends and news.
We take pride in our team of experts that mot only ideate but help add unique expertise to our content, with opinions, hot takes, hands on examples and walkthroughs.
2. Every content piece strives to add unique value and perspective
At Qodo we have our minds and vision on everything related to code governance, code quality and code review. With years of experience in software development, cyber security and mahine learning we have our vision and take on every topic, news article or trend – we make sure to reflect it in our content. In every piece you will hear our opinion, our voice.
We are lucky to have a lot of valuable internal data, we also run our own code review benchmar, research, podcasts, and annual State of code quality report – all of that unique data and takeaways goes into our articles.
Finally, as all developers we love hands on, real workflows and working code examples. Everything is written by our internal team of DevRel engineers, and testied for code quality and security before publishing.
3. We take accuracy and fact-ckecking seriously
We never use AI for research or source of information. We always go to the original sources of information, be it a software company pricing page, and article, a research or a Linkedin post. Furthermore, we always add a link to the primary source and date on which the information was taken, in case something changes since the article was published. This makes sure our readers have a ful awareness of when and from where the information is coming and builds trust.
4. An engineer reviews every piece, and a named person approves it
No piece goes live on one person’s draft. An engineer checks product claims, descriptions of other tools, and every quote, statistic and link.
The reviewer is expected to push back on the angle, the evidence and the fairness of comparisons.
Anna Uss, who leads content at Qodo, is the final approver: she signs off on every piece before it is published, on every platform.
5. Ethical use of AI is key: AI helps us edit, people supply the facts and the expertise
We use AI with transparency, and only in ways that leave the substance to people.
For example:
- Proofreading our own draft. AI flags spelling, grammar and punctuation errors while preserving our meaning, and we review every suggestion.
- Organising ideas we already have. We ask for an outline built only from our notes, with no added information.
- Improving readability. It shortens sentences or splits long paragraphs, without adding claims or changing facts.
- We add a disclosure to every article for full transparency.