Writing an Engaging, SEO-Friendly Technical Content: Tips from Fellow Creators


The role of writers in building brands is indispensable today. From global tech giants like Facebook to budding startups, carefully articulated content is essential in attracting consumers, building user base, and maximising user retention rate. Aviyel works with creators around the globe and features informative content around open source projects.
Here’s a quick guide to the basics of technical writing that certainly answers- how to begin with technical writing from a scratch with Aviyel.



Who are we?

Aviyel works with open source creators to build and incentivise active communities, achieve financial independence and increase adoption of their projects. At Aviyel, we are building a knowledge repository to share their contents, experiences, and support for open source projects. We are the bridge connecting open source communities, businesses, and developers who build great products.



Role of freelancers in building a platform like Aviyel

Great open source projects deserve great content. Open source has always had a content problem creating difficulties connecting with the audience. Here’s where writers come into the picture. Creators are a building block of any organisation, regardless of the size. The content developers through their product allow companies like Aviyel to kickstart the conversations around open source and help OSS projects to climb the desired mark. We want you to help build OSS communities for our partners through your content.



What do enterprises expect from creators?

To create well-planned, well-researched, and well-crafted articles. Inform the developer ecosystem, stimulate a new and critical discourse around Open Source creators, projects, and community. The blog post should sound human and curated in a way that all reader questions are answered. While preparing a draft of your blog, please ask yourself if this is what I want to read as a reader? This is how you will polish your writing style by quick elimination and bringing rigor to your content. If you encounter any difficulty while writing/formulating your thoughts on a write-up, reach out to our content community and Aviyel’s content management team on our Discord channel. Above all, we will assist each other to learn, grow and accomplish their missions in life.



Voice and Tone

Generally, most articles follow this standard:



Voice



Tone



Word Count

The article should contain around 1500 words. Although, editors do appreciate you going the extra mile, please make sure the extra content adds rigor and value to your content, rather than make it dormant.



Structure of Blog

Sample– Aviyel is partnering with MobSF to deliver a one-of-a-kind mobile security infrastructure available in the electronics industry. We are embarking on a journey to monetise open source software and build a developers-driven community with constant flow of knowledge, ideas, and goals. To know more about Aviyel’s recent endeavors, follow our discussions here. Join Aviyel’s Twitter space at AviyelHQ.
Moreover, the structure of your blog primarily depends on the niche of your post. For instance, if you are curating a step by step tutorial or contribution guide, try to include some generalised pointers like prerequisites, attributions and a summary of your writeup in conclusion. Similarly, if you are attempting a benchmarking article, make sure to enlist pros, cons, and difference between the two technologies you are writing about. You can checkout a sample guide



Keyword Optimisation

This is the heart and soul of your write-up. A blog mainly consists of 5-7 main keywords out of which primary keyword will lift your blog ranking. To rank your blog on search engines, please ensure your keyword is stuffed at the right places. Do not overuse your keywords. An ideal keyword density means using your primary keyword once in every three lines. Please follow the ritual the next time you draft an article. Other pointers:



Plagiarism



Important Pointers



Formatting



Headlines/Titles



Subheads



Body



Images

Whenever you download images from Google Images, make sure the title of the blog is the title of your images. When inserting the image in the doc/CMS platform, please caption the image with the primary keyword.
If project title- MobSF: Best practices and Tips
Image captions can be Features of MobSF/Analysis of Mobile Security Framework



Embeddable Content

Here, I am talking from Aviyel’s perspective;



Aviyel House Style

business
Plural: businesses
Sing. possessive: business’s
Plural possessive: businesses’

email
One word, no hyphen.
internet
Always lowercase except when used as part of a name or proper noun.
log in/login
log in (intransitive verb), and login (adjective, noun). Never “log on,” never hyphenated.
Log into the master as root.
Log in to complete the steps.
multicloud
One word, no hyphen.
operating system
The foundational software that runs a computer, server, mobile device. OS is acceptable on second use. operating systems, OSs
open source software
No hyphen between open and source. Do not capitalise on open source in between the sentences.
software
As an uncountable noun, software is always singular.
job titles
Do not capitalise job titles unless they follow a name or are used as part of the name.
Co-Founder Jose Kuttan
Jose Kuttan, the co-founder of Aviyel



Sourcing



Attribution



In line in copy

To read the full article, tap here

Source: DEV Community

October 11, 2021
Category : News
Tags: opensource | programming | writing

Leave a Reply

Your email address will not be published. Required fields are marked *

Sitemap | Terms | Privacy | Cookies | Advertising

Senior Software Developer

Creator of @LzoMedia I am a backend software developer based in London who likes beautiful code and has an adherence to standards & love's open-source.