₦airaland Forum

Welcome, Guest: Join Nairaland / LOGIN! / Trending / Recent / New
Stats: 2,319,302 members, 5,114,443 topics. Date: Saturday, 24 August 2019 at 07:10 PM

There Should Be A New Role Called Technical Documenter - Programming - Nairaland

Nairaland Forum / Science/Technology / Programming / There Should Be A New Role Called Technical Documenter (115 Views)

Need A Technical Partner (web & App Developer) / In Need Of A Technical Co-founder / Technical Partner Needed (as Cto) (2) (3) (4)

(1) (Reply)

There Should Be A New Role Called Technical Documenter by zum19: 3:20pm On Aug 14
Most API documentation are a mess.
An API documentation supposed to be clear and easy to understand, there should be no headache to integrate.

Many developers are poor in creating API documentations to integrate to their systems. Maybe because of the amount of work they have at hand and no time to really focus or too lazy or wicked to come up with an easy to understand API integration documentation.

That's were a "Technical Documenter or Writer " comes in. His/her role will be to document complex systems of a developer, in an easy to follow format. In such a way that an intermediate developer can understand. That's just his job, he tests the endpoints, ensures they work & give the right response, then documents how it's done.

An API documentation should have a sample working code in about 3 or 4 different programming language.

Some Industries in Nigeria with API Integration headaches

1. Telecoms VAS(The poorest when it comes to this, in short the have the most disorganized set of documentation. Alot of things here are just word in the winds)
2. Payment processor companies

No company names mentioned, you guys know yourselves and should change.

(1) (Reply)

React Native Activityindicator Andriod IOS Example / Be A Member / Bypass Icloud Activation For Free

(Go Up)

Sections: politics (1) business autos (1) jobs (1) career education (1) romance computers phones travel sports fashion health
religion celebs tv-movies music-radio literature webmasters programming techmarket

Links: (0) (1) (2) (3) (4) (5) (6) (7) (8) (9)

Nairaland - Copyright © 2005 - 2019 Oluwaseun Osewa. All rights reserved. See How To Advertise. 15
Disclaimer: Every Nairaland member is solely responsible for anything that he/she posts or uploads on Nairaland.