View Onsite technical writing jobs below.
BattaBox is Nigeria's most exciting and original News & Entertainment video channel! Our team of Presenters & Camera Crews bring you Nigeria like you've never ...
Del-York Medi is a full-scale media,marketing and communications companyAbout the job The primary goal of a copywriter will be to write persuasive and ...
Eloquent Digital is an established web development, branding and Digital marketing company delivering web development services and E-commerce Solutions of any ...
HRLeverage Africa is in tune with the global shakeups and as such we also provide solution to talented staff who may have been affected by a downsized ...
Sanieldan Properties Limited is a Real Estate Development (Commercial and Residential), Facility Management, Civil Engineering and Construction. Vision ...
Kuda is a full-service, app-based digital bank. Our mission is to be the go-to bank not just for those living on the African continent, but also for the ...
Alan & Grant, is a Human Resources and Business Advisory firm. By combining creative and strategic minds, we co-create relevant and impactful solutions to ...
MyJobMag's goal is to solve the fundamental employment challenge in Africa which cuts across employer-employee quality and discovery. From internship ...
What We Do For discerning entities looking to build wealth in Nigeria through a credible platform that provides the information, professionals, and tools to ...
Flex Finance - We help free business owners and finance teams in Africa from the stress of spend management. We make this aspect of business delightfully ...
We are Aegle, Africa�s leading health technology company, and we engineer the flow of standard healthcare solutions by integrating artificial intelligence ...
3rdFloor Digital is an integrated digital marketing consultancy that specialises in utilising a range of digital assets to aid and improve the business ...
Aldreda Fields Limited (AFL Networks) is licensed by the Nigerian Communications Commission (NCC) to provide Metropolitan Fibre Cable Network Services in ...
We do food right. Let's hook you up the tastiest crispy chicken-to-the-bone, crunchy fish fillet; soup/food bowls; surprise trays, & other yummy meals. ...
Responsibilities Interpreting creative direction and technical information and turning them into copy concepts Drive brand consistency across all company ...
Prospa is a technology company building the operating system for African entrepreneurs and businesses. Our mission is to support Africans in building financial ...
Technical writing is about simplifying complex things. It is a form of writing discipline that involves communicating complex information to those who need it to carry out a specific task or achieve a certain goal. It is vital to a wide range of businesses and industries because, with it, complex topics and procedures in these fields would be easier to understand.
Some of the components that make technical writing unique include:
The writing must be clear and easy to understand since it is explaining an already difficult concept.
The writing should be well-detailed, leaving no important information out.
It must be well structured, showing step-by-step instructions needed to simplify the concept.
The writing must of course solve a problem and provide enough value to the readers.
Standard Operating Procedures (SOP)
Standard operating procedures (SOPs) are detailed guidelines outlining organizational tasks, promoting seamless operations. It may include everything from processing payroll to manufacturing guidelines and calculating vacation time.
Software Installation Guides
As the name implies, a software installation guide is written to guide users on how to install software. It would usually contain workflows, video tutorials, FAQs, and a troubleshooting guide.
Press Releases
Press releases are formal documents released by organizations to make business-related announcements. It usually highlights how the announcement impacts users and external stakeholders of the organization.
Case Studies and White Papers
Case studies & whitepapers are industry-specific documents that provide real-world examples testifying to an organization’s expertise and value, and are used for lead generation purposes.
They are written to address a particular challenge and require that the writer has an in-depth knowledge of the industry for effective writing.
API Documentation
API documentation helps the customers’ developers of a product interact easily with the product’s code to implement an API effectively. It contains instructions and tutorials to simplify integration with other APIs such as web API, software API, and SCPIs.
Other forms of technical writing include:
User Manuals
Service Level Agreements
Business Proposals
End-user Instructions
Technical Reports
A clear understanding of the product you intend to write on, the functions, solutions it provides, repair, replacement and troubleshooting.
In-depth knowledge of your product’s industry
Proper research skills to understand the content and do a detailed audience analysis.
Strong communication skills to communicate appropriately through writing.
Knowledge of technical writing tools like WordPress, Adobe RoboHelp, Google Docs, etc.
Basic graphics and web design skills.